Skip to main content

Projects

A Neptune project typically represents one machine learning task. All of your tracked runs appear in the project, letting other team members explore and analyze experiments through shared views and reports.

Create a project​

Via web app​

In the left nav:

  1. Click the projects menu and select Go to all projects.

  2. Select Create new project.

  3. Enter a name for the project.

    Use at least three characters, which can be letters, digits, or hyphens (-).

  4. Configure the other options as needed and click Create.

Via API​

To create a project via the Python API:

from neptune_scale.projects import create_project

create_project(
    name="project-x",
    workspace="team-alpha",  # a workspace with this name must already exist
)

Find project name​

The project path is workspace-name/project-name. To find and copy it:

  1. In the Neptune app, open the project menu ().

  2. From the dropdown, select Settings.

Project menu in the Neptune app.

Set project path as environment variable​

By saving the project path to an environment variable, you don't have to specify it in your code every time. This approach is more convenient and secure.

For details, see Save credentials as environment variables.