Projects

Projects

Interact with projects in the Driverless AI server.

create

create(
    name: str, description: str | None = None, force: bool = False
) -> Project

Creates a project in the Driverless AI server.

Parameters:

• name (str) –

  Display name for project.

• description (str | None, default: None ) –

  Description of project.

• force (bool, default: False ) –

  Whether to create the project even when a project already exists with the same name.

Returns:

• Project –

  Created project.

get

get(key: str) -> Project

Retrieves a project in the Driverless AI server.

Parameters:

• key (str) –

  The unique ID of the project.

Returns:

• Project –

  The project corresponding to the key.

get_by_name

get_by_name(name: str) -> Project | None

Retrieves a project by its display name from the Driverless AI server.

Parameters:

• name (str) –

  Name of the project.

Returns:

• Project | None –

  The project with the specified name if it exists, otherwise None.

Beta API

A beta API that is subject to future changes.

gui

gui() -> Hyperlink

Returns the full URL to the Projects page in the Driverless AI server.

Returns:

• Hyperlink –

  The full URL to the Projects page.

list

list(start_index: int = 0, count: int = None) -> Sequence[Project]

Retrieves projects in the Driverless AI server.

Parameters:

• start_index (int, default: 0 ) –

  The index of the first project to retrieve.

• count (int, default: None ) –

  The maximum number of projects to retrieve. If None, retrieves all available projects.

Returns:

• Sequence[Project] –

  Projects.

Project

A project in the Driverless AI server.

datasets property

datasets: dict[str, Sequence[Dataset]]

Datasets linked to the project.

Returns:

• dict[str, Sequence[Dataset]] –

   

description property

description: str | None

Description of the project.

Returns:

• str | None –

   

experiments property

experiments: Sequence[Experiment]

Experiments linked to the project.

Returns:

• Sequence[Experiment] –

   

key property

key: str

Universally unique key of the entity.

Returns:

• str –

   

name property

name: str

Name of the entity.

Returns:

• str –

   

sharings property

sharings: list[dict[str, str | None]]

Users with whom the projects have been shared with when the H2O Storage is connected.

Returns:

• list[dict[str, str | None]] –

   

delete

delete(include_experiments: bool = False) -> None

Permanently deletes the project from the Driverless AI server.

Parameters:

• include_experiments (bool, default: False ) –

  Unlink & delete experiments linked to the project.

get_dataset_tags

get_dataset_tags(dataset: Dataset) -> list[str]

Returns the tags set for a particular dataset linked to the project.

Parameters:

• dataset (Dataset) –

  A dataset linked to the project.

Returns:

• list[str] –

  Tags of the dataset.

Driverless AI version requirement

Requires Driverless AI server 1.11.0 or higher.

get_experiment_tags

get_experiment_tags(experiment: Experiment) -> list[str]

Returns the tags set for an experiment linked to the project.

Parameters:

• experiment (Experiment) –

  An experiment linked to the project.

Returns:

• list[str] –

  Tags of the experiment.

gui

gui() -> Hyperlink

Returns the full URL to the project details page in the Driverless AI server.

Returns:

• Hyperlink –

  URL to the project details page.

link_dataset

link_dataset(
    dataset: Dataset,
    dataset_type: str,
    link_associated_experiments: bool = False,
) -> Project

Links a dataset to the project.

Parameters:

• dataset (Dataset) –

  The dataset to be linked.

• dataset_type (str) –

  Type of the dataset. Possible values are train_dataset, validation_dataset, or test_dataset.

• link_associated_experiments (bool, default: False ) –

  Also link experiments that used the dataset.

Returns:

• Project –

  This project.

link_experiment

link_experiment(experiment: Experiment) -> Project

Links an experiment to the project.

Parameters:

• experiment (Experiment) –

  The experiment to link.

Returns:

• Project –

  This project.

redescribe

redescribe(description: str) -> Project

Changes the description of the project.

Parameters:

• description (str) –

  New description.

Returns:

• Project –

  This project.

rename

rename(name: str) -> Project

Changes the display name of the project.

Parameters:

• name (str) –

  New display name.

Returns:

• Project –

  This project.

share

share(username: str, role: str = 'Default') -> None

Shares the project with a user when H2O Storage is connected.

Parameters:

• username (str) –

  Driverless AI username of user to share with.

• role (str, default: 'Default' ) –

  Role for the user. Possible values are Default or Reader.

unlink_dataset

unlink_dataset(dataset: Dataset, dataset_type: str) -> Project

Unlinks a dataset from the project.

Parameters:

• dataset (Dataset) –

  The dataset to be unlinked.

• dataset_type (str) –

  Type of the dataset. Possible values are train_dataset, validation_dataset, or test_dataset.

Returns:

• Project –

  This project.

unlink_experiment

unlink_experiment(experiment: Experiment) -> Project

Unlinks an experiment from the project.

Parameters:

• experiment (Experiment) –

  The experiment to be unlinked.

Returns:

• Project –

  This project.

unshare

unshare(username: str) -> None

Unshare the project when H2O Storage is connected.

Parameters:

• username (str) –

  Driverless AI username of user to unshare with.

update_dataset_tags

update_dataset_tags(dataset: Dataset, tags: list[str]) -> None

Updates tags from a dataset linked to the project.

Parameters:

• dataset (Dataset) –

  A dataset linked to the project.

• tags (list[str]) –

  New tags.

Example

Create a project, link a dataset, and remove all existing tags.

project = client.projects.create(
    name="test project",
    description="project description",
)
project.link_dataset(dataset)
project.update_dataset_tags(dataset, [])

Driverless AI version requirement

Requires Driverless AI server 1.11.0 or higher.

update_experiment_tags

update_experiment_tags(experiment: Experiment, tags: list[str]) -> None

Updates tags from an experiment linked to the project.

Parameters:

• experiment (Experiment) –

  experiment: An experiment linked to the project.

• tags (list[str]) –

  New tags.

Example

Create a project, link an experiment, and remove all existing tags.

project = client.projects.create(
    name="test project",
    description="project description",
)
project.link_experiment(experiment)
project.update_experiment_tags(experiment, [])