Skip to main content

Projects

Project Management​

Create Project​

create_project(base_model_path, params, dynamic_trainer_key?, dynamic_trainer_path?)​

Create a project with a base model and configuration parameters.

Method Parameters​

base_model_path | required string

Path to the base model or identifier, depending on environment.

params | required dict

Project creation parameters and configuration.

dynamic_trainer_key | optional string

Identifier for a previously uploaded dynamic trainer.

dynamic_trainer_path | optional string

Local path to a dynamic trainer package to upload and use.

Returns​

Project object JSON.

Example​

project = dfl.create_project(
    base_model_path="/models/base-model",
    params={"learning_rate": 3e-5, "epochs": 1},
)

Get Project​

get_project(project_key)​

Fetch a project by key.

Method Parameters​

project_key | required string

Unique project identifier.

Returns​

Project object JSON.

Example​

project = dfl.get_project(project_key="proj_abc123")

Get Projects​

get_projects()​

List all projects accessible to the user.

Returns​

List[Project] JSON objects.

Example​

projects = dfl.get_projects()

Delete Project​

delete_project(key)​

Delete a project by key.

Method Parameters​

key | required string

Unique project identifier.

Returns​

Deletion status JSON.

Example​

dfl.delete_project(key="proj_abc123")

Centralized Projects​

Create Centralized Project​

create_centralized_project(name, datasource_key, rounds?, use_case_key?, use_case_path?)​

Create a centralized project with a datasource and optional use‑case configuration.

Method Parameters​

name | required string

Project name.

datasource_key | required string

Identifier of the datasource to attach.

rounds | optional int

Number of rounds.

use_case_key | optional string

Identifier of a predefined use case.

use_case_path | optional string

Local path to a use case configuration.

Returns​

Project object JSON.

Example​

dfl.create_centralized_project(
    name="My Centralized Project",
    datasource_key="ds_123",
    rounds=1,
)
Last updated on