openlayer.OpenlayerClient.create_project#

OpenlayerClient.create_project(name, task_type, description=None)#

Creates a project on the Openlayer platform.

Parameters
namestr

Name of your project.

Important

The project name must be unique in a user’s collection of projects.

task_typeTaskType

Type of ML task. E.g. TaskType.TabularClassification or TaskType.TextClassification.

descriptionstr

Project description.

Returns
Project

An object that is used to upload models and datasets to the Openlayer platform that also contains information about the project.

Examples

Instantiate the client and create the project:

>>> import openlayer
>>> client = openlayer.OpenlayerClient('YOUR_API_KEY_HERE')
>>>
>>> from openlayer.tasks import TaskType
>>> project = client.create_project(
...     name="Churn prediction",
...     task_type=TaskType.TabularClassification,
...     description="My first error analysis playground",
... )

With the Project object created, you are able to start uploading models and datasets to the platform. Refer to add_model and obj:add_dataset or obj:add_dataframe for detailed examples.