Scan

Scan


update

Signature

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

Signature

launch(
   gpus: int = 1
)

Description

Distribute runs remotely for this scan.

:information-source: The remote environment has to be setup prior launching the experiment.
It defaults to our remote training engine.

Examples

    scan.launch()

list_runs

Signature

list_runs()

Description

Retrieve all runs of this scan

Examples

    scan.list_runs()

Returns

A list of Run object manipulable


get_run

Signature

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

Signature

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

Signature

get_next_run()

Description

Get next available Run for Scan.

Examples

    scan.get_next_run()

Returns

A Run object manipulable


delete

Signature

delete()

Description

Delete this scan from the platform.

:warning: DANGER ZONE: Be very careful here!

Examples

    scan.delete()

get_script

Signature

get_script()

Description

Retrieve the script of this scan.

Returns

A ScanFile object


list_data_files

Signature

list_data_files()

Description

List all data files of this scan

Examples

    files = scan.list_data_files()

Returns

List of ScanFile object