Skip to content

Documentation for Project and related classes

Project

The object model represents a project in the Engine

add_user(user_email, role=UserRoles.ProjectViewer)

Add an existing user to the project

Parameters:

Name Type Description Default
user_id str

Unique identity of the added user

required
role str

Role of the user in the project. Defaults to UserRoles.ProjectViewer.

UserRoles.ProjectViewer

create_app(name, dataset_id, config, description='', timeout=DEFAULT_TIMEOUT)

Create a new ML application

Parameters:

Name Type Description Default
name str

Name of the application

required
dataset_id str

ID of the input dataset

required
config Union[ClassificationConfig, RegressionConfig, ClusteringConfig]

Configuration for the problem type

required
training_data_proportion float

train/test split ratio. Deprecated. Use train_data_propotion of . Defaults to 0.8.

required
description str

Descripton of the application. Defaults to "".

''
timeout int

waiting time for the app to be processed. Defaults to DEFAULT_TIMEOUT.

DEFAULT_TIMEOUT

Raises:

Type Description
Exception

description

Returns:

Name Type Description
App

description

create_dataset(name, data_source, timeout=DEFAULT_TIMEOUT)

Create a dataset in the project from a data source (File or Database)

Parameters:

Name Type Description Default
project_id str

ID of the project in which this dataset is imported

required
name str

name of the dataset

required
data_source DataSource

source of data to be imported

required
columns

Schema of the

required

Returns:

Name Type Description
str

ID of newly created dataset

delete()

Delete the project.

Warning

All related data (datasets, recipes, apps) of the project will be deleted.

description() property

Description of the project

Returns:

Name Type Description
str str

Description of the project

list_apps()

Get all apps in the project

Returns:

Type Description
List[App]

List[App]: List of applications in the projects

list_user_projects() staticmethod

Return all projects which can be accessed by the current user

Returns:

Type Description

List of projects which can be accessed by the current user

list_users()

Return all users of the project

Returns:

Type Description

List of project users

name() property

Name of the project

Returns:

Name Type Description
str str

Name of the project

remove_user(user_email)

Remove a user from the project

Parameters:

Name Type Description Default
user_id str

Unique identity of the removed user

required

update(name, description=None)

Update information of the project

Parameters:

Name Type Description Default
name str

updated project name

required
description str

updated project description. Defaults to None.

None

ProjectUser dataclass

The object model represents a user in the project

role: str class-attribute

Role of user in the project

user: User class-attribute

User information