|
1 | | -# Using SwanLab as a Team |
| 1 | +# Using SwanLab in Teams |
2 | 2 |
|
3 | | -:::warning |
| 3 | +## Creating an Organization |
4 | 4 |
|
5 | | -Organization creation is now fully open, with a maximum of 15 people per organization. |
| 5 | +In the top-left corner of the homepage, click the "Create Organization" button. Fill in the organization name, organization ID, and other relevant information to complete the creation of the organization. |
6 | 6 |
|
7 | | -::: |
| 7 | +<div align="center"> |
| 8 | +<img src="/assets/organization-create.jpg" width="400"> |
| 9 | +</div> |
8 | 10 |
|
9 | | -## Create an organization |
| 11 | +## Inviting Members |
10 | 12 |
|
11 | | -At the bottom left of the homepage, click the "Create a new organization" button and fill in the organization name to complete the organization creation. |
| 13 | +<div align="center"> |
| 14 | +<img src="./organization/invite.png"> |
| 15 | +</div> |
12 | 16 |
|
| 17 | +Under the organization space, navigate to "Settings" -> "General." In the "Members" section, click the "Invite Members" button and share the invitation link with the members you want to join the organization. |
13 | 18 |
|
14 | 19 | <div align="center"> |
15 | | -<img src="/assets/organization-create.jpg" width="400"> |
| 20 | +<img src="./organization/join.png"> |
16 | 21 | </div> |
17 | 22 |
|
18 | | -## Upload experiments to the organization space |
| 23 | +Members can click the invitation link and submit their application. Once approved by the administrator, they will successfully join the organization. |
| 24 | + |
| 25 | +## Uploading Experiments to the Organization Space |
19 | 26 |
|
20 | | -By default, your project will be uploaded to your personal space. |
21 | | -To upload to the organization space, set the `workspace` parameter of `swanlab.init` to the organization's name (not the organization's nickname). |
| 27 | +By default (i.e., without setting the `workspace` parameter), your project will be uploaded to your personal space. |
| 28 | +To upload it to the organization space, set the `workspace` parameter in `swanlab.init` to the organization's username (not the organization's nickname). |
22 | 29 |
|
23 | 30 | ```python |
24 | 31 | import swanlab |
25 | 32 |
|
26 | 33 | swanlab.init( |
27 | | - workspace="[organization name]" |
| 34 | + workspace="[organization username]" |
28 | 35 | ) |
29 | 36 | ``` |
30 | 37 |
|
31 | | -If multiple people in an organization want to collaborate on a project, simply set the `project` parameter of `swanlab.init` to the same one. |
| 38 | +If multiple members of the organization want to collaborate on the same project, simply set the `project` parameter in `swanlab.init` to the same value for all collaborators. |
0 commit comments