Properties
nameName of this Scan
Methods
update
update(
name: Optional[str] = None, metric_name: Optional[str] = None,
metric_goal: Optional[str] = None, requirements: Union[List[Dict], str,
None] = None, base_model: Optional[ModelVersion] = None,
base_dataset: Optional[DatasetVersion] = None, script: Optional[ScanFile] = None,
image: Optional[str] = None
)
Description
Update this data source with a new name.
Examples
sdk_source.update(name="new name")
launch
launch(
gpus: int = 1
)
Description
Distribute runs remotely for this scan.
The remote environment has to be setup prior launching the experiment.
It defaults to our remote training engine.
Examples
scan.launch()
list_runs
list_runs()
Description
Retrieve all runs of this scan
Examples
scan.list_runs()
Returns
A list of Run object manipulable
get_run
get_run(
order: int
)
Description
Retrieve a run object by its order in its scan
Examples
scan.get_run(1)
Arguments
- order (int) : order of the run
Returns
A Run object manipulable
get_run_by_id
get_run_by_id(
id: Union[UUID, str]
)
Description
Retrieve a run object by its id.
Examples
scan.get_run_by_id("cb750009-4e09-42bb-8c84-cc78aa004bf0")
Arguments
- id (str) : id (primary key) of the run on Picsellia
Returns
A Run object manipulable
get_next_run
get_next_run()
Description
Get next available Run for Scan.
Examples
scan.get_next_run()
Returns
A Run object manipulable
delete
delete()
Description
Delete this scan from the platform.
DANGER ZONE: Be very careful here!
Examples
scan.delete()
get_script
get_script()
Description
Retrieve the script of this scan.
Returns
A ScanFile object
list_data_files
list_data_files()
Description
List all data files of this scan
Examples
files = scan.list_data_files()
Returns
List of ScanFile object