Struct Client 

pub struct Client { /* private fields */ }

A client for making HTTP requests to the Burn Central API.

The client can be used to interact with the Burn Central server, such as creating and starting experiments, saving and loading checkpoints, and uploading logs.

Implementations

impl Client

pub fn create_artifact( &self, owner_name: &str, project_name: &str, exp_num: i32, req: CreateArtifactRequest, ) -> Result<ArtifactCreationResponse, ClientError>

Creates an artifact entry on the Burn Central server with the given files.

The client must be logged in before calling this method.

pub fn add_files_to_artifact( &self, owner_name: &str, project_name: &str, exp_num: i32, artifact_id: &str, files: Vec<ArtifactFileSpecRequest>, ) -> Result<ArtifactAddFileResponse, ClientError>

Add files to an existing artifact.

The client must be logged in before calling this method.

pub fn complete_artifact_upload( &self, owner_name: &str, project_name: &str, exp_num: i32, artifact_id: &str, file_names: Option<Vec<String>>, ) -> Result<(), ClientError>

Complete an artifact upload.

The client must be logged in before calling this method.

If file_names is None, all files in the artifact will be marked as complete. If file_names is Some, only the specified files will be marked as complete.

pub fn list_artifacts( &self, owner_name: &str, project_name: &str, exp_num: i32, ) -> Result<ArtifactListResponse, ClientError>

List artifacts for the given experiment.

The client must be logged in before calling this method.

pub fn list_artifacts_by_name( &self, owner_name: &str, project_name: &str, exp_num: i32, name: &str, ) -> Result<ArtifactListResponse, ClientError>

Query artifacts by name for the given experiment.

The client must be logged in before calling this method.

pub fn get_artifact( &self, owner_name: &str, project_name: &str, exp_num: i32, artifact_id: &str, ) -> Result<ArtifactResponse, ClientError>

Get details about a specific artifact by its ID.

The client must be logged in before calling this method.

pub fn presign_artifact_download( &self, owner_name: &str, project_name: &str, exp_num: i32, artifact_id: &str, ) -> Result<ArtifactDownloadResponse, ClientError>

Request presigned URLs to download an artifact’s files from the Burn Central server.

The client must be logged in before calling this method.

impl Client

pub fn new( env: Env, credentials: &BurnCentralCredentials, ) -> Result<Self, ClientError>

Create a new HttpClient with the given base URL and API key.

pub fn from_url( url: Url, credentials: &BurnCentralCredentials, ) -> Result<Self, ClientError>

👎Deprecated

Please use environment based constructor

pub fn get_endpoint(&self) -> &Url

👎Deprecated

Please use environment instead of url

pub fn get_env(&self) -> &Env

pub fn upload_bytes_to_url( &self, url: &str, bytes: Vec<u8>, ) -> Result<(), ClientError>

Generic method to upload bytes to the given URL.

pub fn download_bytes_from_url(&self, url: &str) -> Result<Vec<u8>, ClientError>

Generic method to download bytes from the given URL.

impl Client

pub fn create_experiment( &self, owner_name: &str, project_name: &str, description: Option<String>, code_version_digest: String, routine: String, ) -> Result<ExperimentResponse, ClientError>

Create a new experiment for the given project.

The client must be logged in before calling this method.

pub fn create_experiment_run_websocket( &self, owner_name: &str, project_name: &str, exp_num: i32, ) -> Result<WebSocketClient, WebSocketError>

pub fn cancel_experiment( &self, owner_name: &str, project_name: &str, exp_num: i32, ) -> Result<(), ClientError>

Cancel an experiment.

The client must be logged in before calling this method.

impl Client

pub fn start_remote_job( &self, compute_provider_group_name: &str, owner_name: &str, project_name: &str, digest: &str, command: &str, ) -> Result<(), ClientError>

impl Client

pub fn get_model( &self, namespace: &str, project_name: &str, model_name: &str, ) -> Result<ModelResponse, ClientError>

Get details about a specific model.

The client must be logged in before calling this method.

pub fn get_model_version( &self, namespace: &str, project_name: &str, model_name: &str, version: u32, ) -> Result<ModelVersionResponse, ClientError>

Get details about a specific model version.

The client must be logged in before calling this method.

pub fn presign_model_download( &self, namespace: &str, project_name: &str, model_name: &str, version: u32, ) -> Result<ModelDownloadResponse, ClientError>

Generate presigned URLs for downloading model version files.

The client must be logged in before calling this method.

impl Client

pub fn create_user_project( &self, project_name: &str, project_description: Option<&str>, ) -> Result<ProjectResponse, ClientError>

pub fn get_project( &self, owner_name: &str, project_name: &str, ) -> Result<ProjectResponse, ClientError>

pub fn create_organization_project( &self, owner_name: &str, project_name: &str, project_description: Option<&str>, ) -> Result<ProjectResponse, ClientError>

pub fn publish_project_version_urls( &self, owner_name: &str, project_name: &str, target_package_name: &str, code_metadata: BurnCentralCodeMetadataRequest, crates_metadata: Vec<CrateVersionMetadataRequest>, digest: &str, ) -> Result<CodeUploadUrlsResponse, ClientError>

pub fn complete_project_version_upload( &self, owner_name: &str, project_name: &str, code_version_id: &str, ) -> Result<(), ClientError>

impl Client

pub fn login( &self, credentials: &BurnCentralCredentials, ) -> Result<String, ClientError>

Log in to the Burn Central server with the given credentials.

pub fn get_current_user(&self) -> Result<UserResponseSchema, ClientError>

pub fn get_user_organizations( &self, ) -> Result<GetUserOrganizationsResponse, ClientError>

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.