Create and load projects

💡
What is a project?
A project is the logical unit on the platform that houses models, datasets, and goals. Each project is versioned, which means that you can keep track of changes to models and datasets as you push them to the same project. This allows you to maintain a history of your project and enables collaboration with other team members.

Creating a project

There are two ways to create a project on the platform:

Using the UI;
Using the openlayer Python API.

Using the UI

First, log into your Openlayer account.

If you never created a project before, you will have the option to do so on the first page.

Alternatively, if you already have other projects in your workspace, you can find the option to create a new project by clicking on the current project’s name.

To create your project, you should choose a name unique to your workspace and select the project type among the supported ones. After clicking the “Create project” button, your project is created.

Using the Python API

To create a new project on the platform using the Python API, you can use the create_project method.

First, instantiate the Python client with your API key:

import openlayer

client = openlayer.OpenlayerClient("YOUR_API_KEY_HERE")

Then, using the client, create the project using the create_project method:

from openlayer.tasks import TaskType

project = client.create_project(
    name="My project",
    task_type=TaskType.TabularClassification,  # see API reference the supported task_types
    description="Evaluating ML approaches."
)

Refer to the API reference for all the details on the create_project method.

Loading a project

To load a project that already exists in the platform using the Python API, you can use the load_project method.

First, instantiate the Python client with your API key:

import openlayer

client = openlayer.OpenlayerClient("YOUR_API_KEY_HERE")

Then, using the client, load a project using the load_project method and specifying the project’s name:

project = client.load_project(name="My project")

Refer to the API reference for all the details on the load_project method.