finetuner.run module#

class finetuner.run.Run(client, name, experiment_name, config, created_at, description='')[source]#

Bases: object

Class for a run.

Parameters

  • client (FinetunerV1Client) – Client object for sending api requests.

  • name (str) – Name of the run.

  • experiment_name (str) – Name of the experiment.

  • config (dict) – Configuration for the run.

  • created_at (str) – Creation time of the run.

  • description (str) – Optional description of the run.

property name: str#
Return type

str

property config: dict#
Return type

dict

status()[source]#

Run status.

Return type

dict

Returns

A string representing the run status.

logs()[source]#

Check the run logs.

Return type

str

Returns

A string dump of the run logs.

save_artifact(directory='artifacts/')[source]#

Save artifact if the run is finished.

Parameters

directory (str) – Directory where the artifact will be stored.

Return type

str

Returns

A string object that indicates the download path.