Share via

Project Class

  • Reference

Note

This is an experimental class, and may change at any time. Please see https://aka.ms/azuremlexperimental for more information.

A Project is a lightweight object for orchestrating AI applications, and is parented by a hub. Unlike a standard workspace, a project does not have a variety of sub-resources directly associated with it. Instead, its parent hub managed these resources, which are then used by the project and its siblings.

As a type of workspace, project management is controlled by an MLClient's workspace operations.

Inheritance
azure.ai.ml.entities._workspace.workspace.Workspace
Project

Constructor

Project(*, name: str, hub_id: str, description: str | None = None, tags: Dict[str, str] | None = None, display_name: str | None = None, location: str | None = None, resource_group: str | None = None, **kwargs)

Parameters

Name Description
name
Required
str

The name of the project.
hub_id
Required
str

The hub parent of the project, as a resource ID.
description
Required
Optional[str]

The description of the project.
tags
Required
Optional[Dict[str, str]]

Tags associated with the project.
display_name
Required
Optional[str]

The display name of the project.
location
Required
Optional[str]

The location of the project. Must match that of the parent hub and is automatically assigned to match the parent hub's location during creation.
resource_group
Required
Optional[str]

The project's resource group name.

Methods

dump

Dump the workspace spec into a file in yaml format.

dump

Dump the workspace spec into a file in yaml format.

dump(dest: str | PathLike | IO, **kwargs: Any) -> None

Parameters

Name Description
dest
Required
Union[<xref:PathLike>, str, IO[AnyStr]]

The destination to receive this workspace's spec. Must be either a path to a local file, or an already-open file stream. If dest is a file path, a new file will be created, and an exception is raised if the file exists. If dest is an open file, the file will be written to directly, and an exception will be raised if the file is not writable.

Attributes

base_path

The base path of the resource.

Returns

Type Description
str

The base path of the resource.

creation_context

The creation context of the resource.

Returns

Type Description
Optional[SystemData]

The creation metadata for the resource.

discovery_url

Backend service base URLs for the workspace.

Returns

Type Description
str

Backend service URLs of the workspace

hub_id

The UID of the hub parent of the project.

Returns

Type Description
str

Resource ID of the parent hub.

id

The resource ID.

Returns

Type Description
Optional[str]

The global ID of the resource, an Azure Resource Manager (ARM) ID.

mlflow_tracking_uri

MLflow tracking uri for the workspace.

Returns

Type Description
str

Returns mlflow tracking uri of the workspace.