Project Management

Project type

There are two types of projects：

• Public: Visible to anyone. Everyone on the internet can find and see public projects.

• Private: Visible to users specified in the project member settings. Private projects can only be seen by project owners and project members. The project owner can manage access in the project setting of Manage Member.

Create a project

1 Sign in to Starwhale, click Create Project.

2 Type a name for the project.

tip

Avoid duplicate project names.For more information, see Names in Starwhale

3 Select project visibility to decide who can find and see the project.

4 Type a description. It is optional.

5 To finish, click Submit.

Edit a project

The name, privacy and description of a project can be edited.

tip

Users with the project owner or maintainer role can edit a project. For more information, see Roles and permissions

Edit name

• If you are on the project list page:

  1 Hover your mouse over the project you want to edit, then click the Edit button.

  

  2 Enter a new name for the project.

  

  tip

  Avoid duplicate project names. For more information, see Names in Starwhale

  3 Click Submit to save changes.

  

  4 If you're editing multiple projects, repeat steps 1 through 3.

• If you are on a specific project:

  1 Select Overview on the left navigation, and click Edit.

  

  2 Enter a new name for the project.

  

  tip

  Avoid duplicate project names. For more information, see Names in Starwhale

  3 Click Submit to save changes.

  

Edit privacy

• If you are on the project list page:

  1 Hover your mouse over the project you want to edit, then click the Edit button.

  

  2 Click the Public or Private by your command. For more information, see Project types.

  

  3 Click Submit to save changes.

  

• If you are on a specific project

  1 Select Overview on the left navigation, and click Edit.

  

  2 Click the Public or Private by your command. For more information, see Project types.

  

  3 Click Submit to save changes.

  

Edit description

• If you are on the project list page:

  1 Hover your mouse over the project you want to edit, then click the Edit button.

  

  2 Enter any description you want to describe the project.

  

  3 Click Submit to save changes.

  

• If you are on a specific project

  1 Select Overview on the left navigation, and click Edit.

  

  2 Enter any description you want to describe the project.

  

  3 Click Submit to save changes.

  

Delete a project

1 Hover your mouse over the project you want to delete, then click the Delete button.

2 If you are sure to delete, type the exact name of the project and then click Confirm to delete the project.

:::Important: When you delete a project, all the models, datasets, evaluations and runtimes belonging to the project will also be deleted and can not be restored. Be careful about the action. :::

Manage project member

Only users with the admin role can assign people to the project. The project owner defaulted to having the project owner role.

Add a member to the project

1 On the project list page or overview tab, click the Manage Member button, then Add Member.

2 Type the username you want to add to the project, then click a name in the list of matches.

3 Select a project role for the member from the drop-down menu.For more information, see Roles and permissions

4 To finish, click Submit.

Remove a member

1 On the project list page or project overview tab, click the Manage Member button.

2 Find the username you want to remove in the search box, click Remove, then Yes.