Workspaces

Workspace

Represent a Vectice Workspace.

Workspaces are containers used to organize projects, assets, and users.

Vectice users have access to a personal workspace and other workspaces so they can learn and collaborate with other users. An organization will have many workspaces, each with an Admin and Members with different privileges.

Note that only an Org Admin can create a new workspace in the organization.

You can get a workspace from your Connection object by calling workspace():

import vectice

connect = vectice.connect(...)
workspace = connect.workspace("Iris workspace")

Or you can get it directly when connecting to Vectice:

import vectice

workspace = vectice.connect(..., workspace="Iris workspace")

See Connection.connect to learn how to connect to Vectice.

connection property

connection

The Connection to which this workspace belongs.

Returns:

Type	Description
Connection	The Connection to which this workspace belongs.

description property

description

The workspace's description.

Returns:

Type	Description
str | None	The workspace's description.

id property

id

The workspace's id.

Returns:

Type	Description
str	The workspace's id.

name property

name

The workspace's name.

Returns:

Type	Description
str	The workspace's name.

properties property

properties

The workspace's name and id.

Returns:

Type	Description
dict	A dictionary containing the name and id items.

create_project

create_project(
    name,
    description=None,
    template=None,
    copy_project_id=None,
)

Creates a project.

Parameters:

Name	Type	Description	Default
name	str	The project's name.	required
description	str | None	The project's description.	None
template	str | None	Creates the project from a spectific template. Available templates options : tutorial, quickstart, default (crisp-dm).	None
copy_project_id	str | None	Creates the project from another project using the id PRJ-XXX. If template parameter is passed, it will take precedent over the project id.	None

Returns:

Type	Description
Project	The newly created project.

list_projects

list_projects(
    number_of_items=DEFAULT_NUMBER_OF_ITEMS,
    display_print=True,
)

Retrieves a list of projects belonging to the workspace. It will also print the first 10 projects as a tabular form.

Parameters:

Name	Type	Description	Default
number_of_items	int	The number of datasets to retrieve. Defaults to 30.	DEFAULT_NUMBER_OF_ITEMS
display_print	bool	If set to True, it will print the first 10 projects in a tabular form.	True

Returns:

Type	Description
list[Project]	A list of Project instances.

list_templates

list_templates(display_print=True)

Retrieves a list of project templates which belong to the workspace. It will also print the first 10 project templates as a tabular form.

Parameters:

Name	Type	Description	Default
display_print	bool	If set to True, it will print the first 10 project templates in a tabular form.	True

Returns:

Type	Description
list[ProjectTemplate]	A list of ProjectTemplate instances.

project

project(project)

Get a project.

Parameters:

Name	Type	Description	Default
project	str	The project name or id.	required

Returns:

Type	Description
Project	The project.