ModelProvenance

class oci.data_science.models.ModelProvenance(**kwargs)

Bases: object

Model provenance gives data scientists information about the origin of their model. This information allows data scientists to reproduce the development environment in which the model was trained.

Methods:

__init__(**kwargs)

Initializes a new ModelProvenance object with values from keyword arguments.

Attributes:

git_branch

Gets the git_branch of this ModelProvenance.

git_commit

Gets the git_commit of this ModelProvenance.

repository_url

Gets the repository_url of this ModelProvenance.

script_dir

Gets the script_dir of this ModelProvenance.

training_id

Gets the training_id of this ModelProvenance.

training_script

Gets the training_script of this ModelProvenance.

__init__(**kwargs)

Initializes a new ModelProvenance object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • repository_url (str) – The value to assign to the repository_url property of this ModelProvenance.

  • git_branch (str) – The value to assign to the git_branch property of this ModelProvenance.

  • git_commit (str) – The value to assign to the git_commit property of this ModelProvenance.

  • script_dir (str) – The value to assign to the script_dir property of this ModelProvenance.

  • training_script (str) – The value to assign to the training_script property of this ModelProvenance.

  • training_id (str) – The value to assign to the training_id property of this ModelProvenance.

property git_branch

Gets the git_branch of this ModelProvenance. For model reproducibility purposes. Branch of the git repository associated with model training.

Returns

The git_branch of this ModelProvenance.

Return type

str

property git_commit

Gets the git_commit of this ModelProvenance. For model reproducibility purposes. Commit ID of the git repository associated with model training.

Returns

The git_commit of this ModelProvenance.

Return type

str

property repository_url

Gets the repository_url of this ModelProvenance. For model reproducibility purposes. URL of the git repository associated with model training.

Returns

The repository_url of this ModelProvenance.

Return type

str

property script_dir

Gets the script_dir of this ModelProvenance. For model reproducibility purposes. Path to model artifacts.

Returns

The script_dir of this ModelProvenance.

Return type

str

property training_id

Gets the training_id of this ModelProvenance. The OCID of a training session(Job or NotebookSession) in which the model was trained. It is used for model reproducibility purposes.

Returns

The training_id of this ModelProvenance.

Return type

str

property training_script

Gets the training_script of this ModelProvenance. For model reproducibility purposes. Path to the python script or notebook in which the model was trained.”

Returns

The training_script of this ModelProvenance.

Return type

str