FrogML Client

Learn how to use the FrogML client through these examples.

The FrogML client is a wrapper and a single entry point for different JFrog ML clients such as the BatchClient, DeploymentClient, and more.

Get a Token from a Pre-Configured Client

get_token

If the frogml-cli is already configured, this method fetches the token from the pre-configured conf file.

from frogml import FrogMLClient

client = FrogMLClient()
token = client.get_token()

Builds

get_latest_build

Returns the latest build by its model ID.

Optionally gets a build_status, by default filters on 'SUCCESSFUL'.

Args:

Returns:

from frogml import FrogMLClient

client = FrogMLClient()
client.get_latest_build(model_id="model_id")

get_builds_by_tags

Returns a list of builds by a given model ID, filtered by a list of build tags.

Note that the method has several options of filtering builds by tags.

Args:

Returns:

from frogml import FrogMLClient

client = FrogMLClient()

# 1. Return builds with either "tag_1" or "tag_2" or both "tag_1" and "tag_2".
#    The builds may have additional tags not listed in the filter.
client.get_builds_by_tags(model_id="model_id", tags=["tag_1", "tag_2"])

# 2. Return builds with both ["tag1", "tag2"] and optional additional tags.
client.get_builds_by_tags(model_id="model_id", tags=['tag1', 'tag2'], include_extra_tags=True, match_any=False)

# 3. Return builds strictly with "tag1" and "tag2" and no additional tags.
client.get_builds_by_tags(model_id="model_id", tags=['tag1', 'tag2'], include_extra_tags=False, match_any=False)

# 4. Return builds with either "tag1" or "tag2" or both, without extra tags.
client.get_builds_by_tags(model_id="model_id", tags=['tag1', 'tag2'], include_extra_tags=False, match_any=True)

list_builds

List builds by its model ID and explicit filters.

Args

Returns

from frogml import FrogMLClient

client = FrogMLClient()
builds_list = client.list_builds(model_id='your-model-id')

list_file_tags

List file tags by its model ID.

Args:

Returns:

from frogml import FrogMLClient
from frogml.core.clients.file_versioning.file_tag_filter import FileTagFilter

client = FrogMLClient()

output = client.list_file_tags(
        model_id="model",
        build_id="build_id",
        filter=FileTagFilter(
                value="value",
                type=FileTagFilter.type.FILE_TAG_FILTER_TYPE_PREFIX
        )
)

list_data_tags

List data tags by its model ID.

Args:

Returns:

from frogml import FrogMLClient
from frogml.core.clients.data_versioning.data_tag_filter import DataTagFilter

client = FrogMLClient()

output = client.list_data_tags(
        model_id="your-model-id",
        build_id="build_id",
        filter=DataTagFilter(
                value="value",
                type=DataTagFilter.type.DATA_TAG_FILTER_TYPE_PREFIX
        )
)

Tags

set_tag

Assign a tag to an existing build.

Args:

Returns:

from frogml import FrogMLClient

client = FrogMLClient()

client.set_tag(build_id="build_id", tag="tag")

set_tags

Assign a list of tags to an existing build.

Args:

Returns:

from frogml import FrogMLClient

client = FrogMLClient()

client.set_tags(build_id="build_id", tags=["tag_1", "tag_2"])

Projects

create_project

Create a new project.

Args:

Returns:

get_project

Get model by its project ID.

Args:

Returns:

list_projects

List projects.

Returns:

from frogml import FrogMLClient 

client = FrogMLClient() 

client.list_projects()

delete_project

Delete project by its project ID.

Args:

Models

create_model

Create a new model.

Args:

Returns:

from frogml import FrogMlClient

client = FrogMlClient()

client.create_model(project_id="project_id", model_name="model_name", model_description="model_description")

get_model

Get model by its model ID.

Args:

Returns:

from frogml import FrogMLClient

client = FrogMLClient()

client.get_model(model_id="model_id")

get_model_metadata

Get model metadata by its model ID.

Args:

Returns:

from frogml import FrogMLClient

client = FrogMLClient()

client.get_model_metadata(model_id="model_id")

delete_model

Delete model by its project & model ID's.

Args:

from frogml.sdk.frogml_client.client import FrogMLClient

client = FrogMLClient()

client.delete_model(project_id="project_id", model_id="model_name")

list_models

Retrieves all models that belong to the project with the given ID.

Args:

from frogml import FrogMLClient

client = FrogMLClient()

client.list_models(project_id="project_id")

list_model_metadata

Retrieves the metadata of all models that belong to the project with a given ID

Args:

from frogml import FrogMLClient

client = FrogMLClient()

client.list_model_metadata(project_id="project_id")

Deployments

get_deployed_build_id_per_environment

Get deployed build ID per environment by its model ID.

Args:

Returns:

from frogml import FrogMLClient

client = FrogMLClient()

client.get_deployed_build_id_per_environment(model_id="your_model_id")

Batch Executions

list_executions

List batch executions by model ID

Args:

Returns:

from frogml import FrogMLClient

client = FrogMLClient()

client.list_executions(model_id="your_model_id", build_id="build_id")

list_execution_tasks

List batch executions tasks by its job ID

Args:

Returns:

from frogml import FrogMLClient

client = FrogMLClient()

client.list_execution_tasks(execution_id="execution_id")