Workspace Management

📘
A workspace is an isolated space that is tied to a specific billing account. Users within a team can create, manage, and segregate their computer vision projects within that workspace using their personal account. All resource usage and quotas for these projects in the workspace are deducted according to the plan that the linked billing account has signed up for. Learn more about Workspaces.

`get_info`

Retrieves details about the current workspace given by the provided secret key, such as the workspace name, workspace owner, and workspace tier.

Arguments

None

Return

Workspace object containing the relevant workspace information with the following structure:

Workspace(
    id="ws_1c8aab980f174b0296c7e35e88665b13",
    name="Raighne's Workspace",
    owner="user_6323fea23e292439f31c58cd",
    tier="Developer",
    create_date=1701927649302
)

Attribute	Type	Description
`id`	`str`	Unique ID of the current workspace.
`name`	`str`	Name of the current workspace. You can directly modify this on Nexus by clicking on the Settings button on the top right of the Workspace Dashboard.
`owner`	`str`	Unique user ID of the workspace owner. This is tied to the email used to sign up for the Nexus account.
`tier`	`str`	Current workspace tier that determines access to advanced features and increased resource quotas. To enjoy these benefits, check out how to Upgrade Your Plan.
`create_date`	`int`	UNIX timestamp of workspace creation date.

Examples

Retrieve information about the workspace tied to the secret key 01048a3572a00dec13a6ca204fa78c0c4c216475c2ca80cb618114d26783d5a2.

from datature.nexus import Client

SECRET_KEY = "01048a3572a00dec13a6ca204fa78c0c4c216475c2ca80cb618114d26783d5a2"
client = Client(SECRET_KEY)
client.get_info()

`list_projects`

List all existing projects created under the workspace given by the provided secret key .

Arguments

None

Return

A list of Project objects containing the project information with the following structure:

[Project(
    id="proj_9004a21df7b040ace4674c4879603fe8",
    name="Cats",
    workspace_id="ws_1c8aab980f174b0296c7e35e88665b13",
    type="ObjectDetection",
    create_date=1701927649302,
    localization="MULTI",
    tags=["cat faces"],
    groups=["main", "cats"],
    statistic=Statistic(
        tags_count=[TagsCountItem(name="cat faces", count=0)],
        total_assets=28,
        annotated_assets=0,
        total_annotations=0
    )
)]

Attribute	Type	Description
`id`	`str`	Unique ID of the project.
`name`	`str`	Name of the project. You can modify this by calling the function `project.update({"name": "YOUR_NEW_PROJECT_NAME"})`, or you can directly modify this on Nexus by clicking on the Settings tab on the left sidebar of the Project Dashboard.
`workspace_id`	`str`	Unique ID of the current workspace that this project is in.
`type`	`str`	Type of project. This can be one of `ObjectDetection`, `InstanceSegmentation`, `Classification`, or `Keypoint` depending on the type selected during project creation on Nexus.
`create_date`	`int`	UNIX timestamp of project creation date.
`localization`	`str`	Region(s) for data localization. Defaults to `MULTI` for multi-region.
`tags`	`list[str]`	List of tag names in the project.
`groups`	`list[str`	List of asset group names in the project.
`statistic`	`Statistic` object	Contains project statistics for the following categories: - `tags_count`: List of `TagCountItem` objects representing tag counts for each tag in the project. - `total_assets`: Total number of assets in the project. - `annotated_assets`: Total number of annotated assets in the project. - `total_annotations`: Total number of annotations in the project.

Examples

Retrieve information about all existing projects under the workspace tied to the secret key 01048a3572a00dec13a6ca204fa78c0c4c216475c2ca80cb618114d26783d5a2.

from datature.nexus import Client

SECRET_KEY = "01048a3572a00dec13a6ca204fa78c0c4c216475c2ca80cb618114d26783d5a2"
client = Client(SECRET_KEY)
client.list_projects()

Iterate through the list of projects and retrieve each project's information one by one:

from datature.nexus import Client

SECRET_KEY = "01048a3572a00dec13a6ca204fa78c0c4c216475c2ca80cb618114d26783d5a2"
client = Client(SECRET_KEY)
projects = client.list_projects()

for project in projects:
  	project.get_info()

`get_project`

Retrieve a specific project's information based on the project key, such as the project type, asset groups, tags, and

Arguments

Name	Type	Description
`project_id`	`str`	The ID of the project. This can be retrieved via two methods: 1. Navigate to the Integrations tab on the left sidebar of your project page, then copy the project key and prepend `proj_` to it. 2. Extract the ID from the URL in your address bar (`https://nexus.datature.io/project/YOUR_PROJECT_ID`) and prepend `proj_` to it.

Return

Project object containing the relevant project information with the following structure:

Project(
    id="proj_9004a21df7b040ace4674c4879603fe8",
    name="Cats",
    workspace_id="ws_1c8aab980f174b0296c7e35e88665b13",
    type="ObjectDetection",
    create_date=1701927649302,
    localization="MULTI",
    tags=["cat faces"],
    groups=["main", "cats"],
    statistic=Statistic(
        tags_count=[TagsCountItem(name="cat faces", count=0)],
        total_assets=28,
        annotated_assets=0,
        total_annotations=0
    )
)

Attribute	Type	Description
`id`	`str`	Unique ID of the project.
`name`	`str`	Name of the project. You can modify this by calling the function `project.update({"name": "YOUR_NEW_PROJECT_NAME"})`, or you can directly modify this on Nexus by clicking on the Settings tab on the left sidebar of the Project Dashboard.
`workspace_id`	`str`	Unique ID of the current workspace that this project is in.
`type`	`str`	Type of project. This can be one of `ObjectDetection`, `InstanceSegmentation`, `Classification`, or `Keypoint` depending on the type selected during project creation on Nexus.
`create_date`	`int`	UNIX timestamp of project creation date.
`localization`	`str`	Region(s) for data localization. Defaults to `MULTI` for multi-region.
`tags`	`list[str]`	List of tag names in the project.
`groups`	`list[str`	List of asset group names in the project.
`statistic`	`Statistic` object	Contains project statistics for the following categories: - `tags_count`: List of `TagCountItem` objects representing tag counts for each tag in the project. - `total_assets`: Total number of assets in the project. - `annotated_assets`: Total number of annotated assets in the project. - `total_annotations`: Total number of annotations in the project.

Examples

Retrieve project information from the project with project key 9004a21df7b040ace4674c4879603fe8

from datature.nexus import Client

SECRET_KEY = "01048a3572a00dec13a6ca204fa78c0c4c216475c2ca80cb618114d26783d5a2"
PROJECT_ID = "proj_9004a21df7b040ace4674c4879603fe8"
client = Client(SECRET_KEY)
project = client.get_project(PROJECT_ID)
project.get_info()