Skip to content

Workspaces and projects#

About workspaces#

A workspace is a space inside Neptune where you can manage projects, people, and your subscription.

The available collaboration features depend on the plan. For details, check the pricing page on the Neptune website.

Tip for students

For academic purposes or Kaggle competitions, you can use the team workspace for free. Create a team workspace and claim non-profit/educational type of organization during setup.1

About projects#

A project typically represents one machine learning task. A project can contain runs, models, model versions, and project-level metadata.

Projects have three levels of visibility:

  • Workspace: Any workspace member can access these projects.
  • Public: Freely available to view by anyone on the internet.
  • Private (only on plans with project-level access control): Only users assigned to the project can see it.

Logging metadata to the project#

To log runs or other data via API, you need the full project name of the project: workspace-name/project-name.

We recommend exporting it as an environment variable in your system, but you can also pass it via the code that initializes Neptune:

run = neptune.init_run(
    project="workspace-name/project-name", # (1)!
  1. For example, if your workspace name is "ml-team" and project name is "classification": project="ml-team/classification"
How do I find my project name?

Your full project name has the form workspace-name/project-name.

For example, if your workspace name (shown in the top-left corner) is "ml-team" and your project is named "classification", your project string is: "ml-team/classification".

To copy the name, click the menu in the top-right corner and select Edit project details.

  1. You should use your ".edu" or non-profit email for this type of account.