openlayer.OpenlayerClient.create_or_load_project

OpenlayerClient.create_or_load_project(name, task_type, description=None)

Convenience function that either creates or loads a project.

If a project with the name specified already exists, it will be loaded. Otherwise, a new project will be created.

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 for the project. E.g. TaskType.TabularClassification or TaskType.TextClassification.

descriptionstr, optional

Project description.

Returns:

Project

An object that is used to interact with projects on the Openlayer platform.

Examples

Related guide: How to create and load projects.

Instantiate the client and create or load the project:

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

With the Project object, you are able to start adding models and datasets to it. Refer to Project.add_model and Project.add_dataset or Project.add_dataframe for detailed examples.