MLModelsMixin

MLModelsMixin#

class MLModelsMixin#

Bases: object

Methods Summary

delete_ml_model(project_id, model_id)

Delete ML Model

get_bulk_labeling(project_id, groundtruth_id)

Get new bulk labeling status.

get_ml_model(project_id, model_id)

Return a single ML Model.

get_ml_models(project_id)

Return all ML Models for a project.

modify_ml_model(project_id, model_id, name)

Update ML Model

new_bulk_labeling(project_id, ...[, ...])

Create new bulk labeling.

new_ml_model(project_id, name, template_id, ...)

Create a new ML Model.

Methods Documentation

delete_ml_model(project_id, model_id)#

Delete ML Model

Parameters:

  • project_id – Id of the Squirro project.

  • model_id – Id of the ML Model.

get_bulk_labeling(project_id, groundtruth_id, ml_workflow_fields=None, ml_job_fields=None, job_count=None)#

Get new bulk labeling status.

Parameters:

  • project_id – Id of the Squirro project.

  • groundtruth_id – id of the grountruth.

  • ml_workflow_fields (Optional[List[str]]) – list of fields of ML workflows

  • ml_job_fields (Optional[List[str]]) – list of fields of ML jobs

get_ml_model(project_id, model_id)#

Return a single ML Model.

Parameters:

  • project_id – Id of the Squirro project.

  • model_id – id of the ML model

get_ml_models(project_id)#

Return all ML Models for a project.

Parameters:

project_id – Id of the Squirro project.

modify_ml_model(project_id, model_id, name, template_id=None, template_params=None, ground_truth_id=None, ground_truth_version=None, is_incomplete=None)#

Update ML Model

Parameters:

  • project_id – Id of the Squirro project.

  • model_id – Id of the Machine Learning workflow.

  • name – Name of the ML Model.

  • template_id – template do be used.

  • template_params – parameters to initialize the template.

  • ground_truth_id – id of the groundtruth.

  • ground_truth_version – version of the groundtruth if any

  • is_incomplete – mark a model as incomplete.

new_bulk_labeling(project_id, groundtruth_id, name, template_id, template_params=None)#

Create new bulk labeling.

Parameters:

  • project_id – Id of the Squirro project.

  • groundtruth_id – id of the grountruth.

  • name – Name of the ML Model.

  • template_id – template do be used.

  • template_params – parameters to initialize the template.

new_ml_model(project_id, name, template_id, ground_truth_id, template_params=None, ground_truth_version=None, is_incomplete=False)#

Create a new ML Model.

Parameters:

  • project_id – Id of the Squirro project.

  • name – Name of the ML Model.

  • template_id – template do be used.

  • template_params – parameters to initialize the template.

  • ground_truth_id – id of the grountruth.

  • ground_truth_version – version of the grountruth if any.

  • is_incomplete – mark a model as incomplete.

Contents