Skip to content

App

Importing the necessary modules

Next you need to import app in order to call functions involved in this module.

from aiaengine.api import app

Creating an app for a dataset

Now you can add a new app by specifying the required parameter values as follows.

create_app_response = client.apps.CreateApp(
    app.CreateAppRequest(
        name='App Name',
        description='What is this app about',
        dataset_id='id_of_dataset_app_is_created_for',
        problem_type='classification',
        target_columns=['target_column'],
        extra_columns={},
        training_data_proportion=0.8
    )
)

app_id = create_app_response.id

Once created, an app is assigned with a unique id, which is frequently used in relevant operations that involve this app.

Retrieving information of an app

Then you can get information of an app by specifying the app id.

client.apps.GetApp(
    app.GetAppRequest(
        id='id_of_app'
    )
)

Updating an app

You can also change the name and description of an app with input of the app id.

client.apps.UpdateApp(
    app.UpdateAppRequest(
        id='id_of_updated_app',
        name='Updated App',
        description='This app has been updated'
    )
)

Deleting an app

Once an app is no longer in use, you can remove it by providing the app id.

client.apps.DeleteApp(
    app.DeleteAppRequest(
        id='id_of_deleted_app'
    )
)

Listing apps within a project

For a particular project, you can list all apps involved in this project by specifying the project id.

client.apps.ListApps(
    app.ListAppsRequest(
        project_id='id_of_project'
    )
)