openlayer.OpenlayerClient#
- class openlayer.OpenlayerClient(api_key=None)#
Client class that interacts with the Openlayer Platform.
- Parameters
- api_keystr
Your API key. Retrieve it from the web app.
Examples
Instantiate a client with your api key
>>> import openlayer >>> client = openlayer.OpenlayerClient('YOUR_API_KEY_HERE')
Methods
add_baseline_model(project_id, task_type[, ...])Coming soon...
add_dataframe(dataset_df, ...[, project_id, ...])Adds a dataset to a project's staging area (from a pandas DataFrame).
add_dataset(file_path, dataset_config_file_path)Adds a dataset to a project's staging area (from a csv).
add_model(model_config_file_path[, ...])Adds a model to a project's staging area.
commit(message, project_id[, force])Adds a commit message to staged resources.
create_or_load_project(name, task_type[, ...])Helper function that returns a project given a name.
create_project(name, task_type[, description])Creates a project on the Openlayer platform.
export(destination_dir, project_id)Exports the commited resources as a tarfile to the location specified by
destination_dir.load_project(name)Loads an existing project from the Openlayer platform.
push(project_id)Pushes the commited resources to the platform.
restore(*resource_names, project_id)Removes the resource specified by
resource_namefrom the staging area.status(project_id)Shows the state of the staging area.