Projects

Project

Represent a Vectice project.

A project reflects a typical Data Science project, including phases and the associated assets like code, datasets, models, and documentation. Multiple projects may be defined within each workspace.

You can get a project from your Workspace object by calling project():

import vectice

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

Or you can get it directly when connecting to Vectice:

import vectice

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

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

connection property

connection

The Connection to which this project belongs.

Returns:

Type	Description
Connection	The Connection to which this project belongs.

description property

description

The project's description.

Returns:

Type	Description
str | None	The project's description.

id property

id

The project's id.

Returns:

Type	Description
str	The project's id.

name property

name

The project's name.

Returns:

Type	Description
str	The project's name.

properties property

properties

The project's identifiers.

Returns:

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

workspace property

workspace

The workspace to which this project belongs.

Returns:

Type	Description
Workspace	The workspace to which this project belongs.

create_phase

create_phase(name, description=None)

Creates a phase.

Parameters:

Name	Type	Description	Default
name	str	The phase's name.	required
description	str | None	The phase's description.	None

Returns:

Type	Description
Phase	The newly created phase.

list_datasets

list_datasets(number_of_items=DEFAULT_NUMBER_OF_ITEMS)

Retrieves a list of dataset representations associated with the current project. See here: https://api-docs.vectice.com/reference/vectice/representation/dataset/

Parameters:

Name	Type	Description	Default
number_of_items	int	The number of datasets to retrieve. Defaults to 30.	DEFAULT_NUMBER_OF_ITEMS

Returns:

Type	Description
list[DatasetRepresentation]	A list of DatasetRepresentation instances corresponding to the datasets in the current project.

list_issues

list_issues(number_of_items=DEFAULT_NUMBER_OF_ITEMS)

Retrieves a list of issue representations associated with the current project. See here: https://api-docs.vectice.com/reference/vectice/representation/issue/

Parameters:

Name	Type	Description	Default
number_of_items	int	The number of issues to retrieve. Defaults to 30.	DEFAULT_NUMBER_OF_ITEMS

Returns:

Type	Description
list[IssueRepresentation]	A list of IssueRepresentation instances corresponding to the issues in the current project.

list_models

list_models(number_of_items=DEFAULT_NUMBER_OF_ITEMS)

Retrieves a list of model representations associated with the current project. See here: https://api-docs.vectice.com/reference/vectice/representation/model/

Parameters:

Name	Type	Description	Default
number_of_items	int	The number of models to retrieve. Defaults to 30.	DEFAULT_NUMBER_OF_ITEMS

Returns:

Type	Description
list[ModelRepresentation]	A list of ModelRepresentation instances corresponding to the models in the current project.

list_phases

list_phases(
    number_of_items=DEFAULT_NUMBER_OF_ITEMS,
    display_print=True,
)

Retrieves a list of phases belonging to the project. It will also print the first 10 phases as a tabular form. A link is provided to view the remaining phases.

Parameters:

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

Returns:

Type	Description
list[Phase]	A list of Phase instances corresponding to the current project.

phase

phase(phase)

Get a phase.

Parameters:

Name	Type	Description	Default
phase	str	The name or id of the phase to get.	required

Returns:

Type	Description
Phase	The specified phase.