Skip to content

Commit 6b8656f

Browse files
Merge pull request #284 from aignostics/update_user_instructions
Update user instructions to improve clarity and structure
2 parents 5c85726 + 9fcb508 commit 6b8656f

File tree

8 files changed

+418
-34694
lines changed

8 files changed

+418
-34694
lines changed

ATTRIBUTIONS.md

Lines changed: 1 addition & 34514 deletions
Large diffs are not rendered by default.

CLI_REFERENCE.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ $ aignostics notebook [OPTIONS] [NOTEBOOK]
5555

5656
**Arguments**:
5757

58-
* `[NOTEBOOK]`: Path to the notebook file to run. If not provided, a default notebook will be used. [default: /Users/helmut/Code/python-sdk/src/aignostics/notebook/_notebook.py]
58+
* `[NOTEBOOK]`: Path to the notebook file to run. If not provided, a default notebook will be used. [default: /Users/omid/Documents/repos/python-sdk/src/aignostics/notebook/_notebook.py]
5959

6060
**Options**:
6161

@@ -118,7 +118,7 @@ $ aignostics application dump-schemata [OPTIONS] APPLICATION_ID
118118
**Options**:
119119

120120
* `--application-version TEXT`: Version of the application. If not provided, the latest version will be used.
121-
* `--destination DIRECTORY`: Path pointing to directory where the input and output schemata will be dumped. [default: /Users/helmut/Code/python-sdk]
121+
* `--destination DIRECTORY`: Path pointing to directory where the input and output schemata will be dumped. [default: /Users/omid/Documents/repos/python-sdk]
122122
* `--zip / --no-zip`: If set, the schema files will be zipped into a single file, with the schema files deleted. [default: no-zip]
123123
* `--help`: Show this message and exit.
124124

@@ -207,7 +207,7 @@ $ aignostics application run execute [OPTIONS] APPLICATION_ID METADATA_CSV_FILE
207207
* `--application-version TEXT`: Version of the application. If not provided, the latest version will be used.
208208
* `--create-subdirectory-for-run / --no-create-subdirectory-for-run`: Create a subdirectory for the results of the run in the destination directory [default: create-subdirectory-for-run]
209209
* `--create-subdirectory-per-item / --no-create-subdirectory-per-item`: Create a subdirectory per item in the destination directory [default: create-subdirectory-per-item]
210-
* `--upload-prefix TEXT`: Prefix for the upload destination. If not given will be set to current milliseconds. [default: 1764110079403.6802]
210+
* `--upload-prefix TEXT`: Prefix for the upload destination. If not given will be set to current milliseconds. [default: 1764159121212.228]
211211
* `--wait-for-completion / --no-wait-for-completion`: Wait for run completion and download results incrementally [default: wait-for-completion]
212212
* `--note TEXT`: Optional note to include with the run submission via custom metadata.
213213
* `--due-date TEXT`: Optional soft due date to include with the run submission, ISO8601 format. The scheduler will try to complete the run by this date, taking the subscription tierand available GPU resources into account.
@@ -275,7 +275,7 @@ $ aignostics application run upload [OPTIONS] APPLICATION_ID METADATA_CSV_FILE
275275
**Options**:
276276

277277
* `--application-version TEXT`: Version of the application. If not provided, the latest version will be used.
278-
* `--upload-prefix TEXT`: Prefix for the upload destination. If not given will be set to current milliseconds. [default: 1764110079403.815]
278+
* `--upload-prefix TEXT`: Prefix for the upload destination. If not given will be set to current milliseconds. [default: 1764159121212.4172]
279279
* `--onboard-to-aignostics-portal / --no-onboard-to-aignostics-portal`: If set, the run will be onboarded to the Aignostics Portal. [default: no-onboard-to-aignostics-portal]
280280
* `--help`: Show this message and exit.
281281

@@ -505,7 +505,7 @@ $ aignostics application run result download [OPTIONS] RUN_ID [DESTINATION_DIREC
505505
**Arguments**:
506506

507507
* `RUN_ID`: Id of the run to download results for [required]
508-
* `[DESTINATION_DIRECTORY]`: Destination directory to download results to [default: /Users/helmut/Library/Application Support/aignostics/results]
508+
* `[DESTINATION_DIRECTORY]`: Destination directory to download results to [default: /Users/omid/Library/Application Support/aignostics/results]
509509

510510
**Options**:
511511

@@ -615,7 +615,7 @@ $ aignostics bucket download [OPTIONS] [WHAT]...
615615
**Options**:
616616

617617
* `--what-is-key / --no-what-is-key`: Specify if 'what' is a single object key. If not specified, 'what' is treated as a regex pattern. [default: no-what-is-key]
618-
* `--destination DIRECTORY`: Destination directory to download the matching objects to. [default: /Users/helmut/Library/Application Support/aignostics/bucket_downloads]
618+
* `--destination DIRECTORY`: Destination directory to download the matching objects to. [default: /Users/omid/Library/Application Support/aignostics/bucket_downloads]
619619
* `--help`: Show this message and exit.
620620

621621
### `aignostics bucket delete`
@@ -777,7 +777,7 @@ $ aignostics dataset idc download [OPTIONS] SOURCE [TARGET]
777777
**Arguments**:
778778

779779
* `SOURCE`: Identifier or comma-separated set of identifiers. IDs matched against collection_id, PatientId, StudyInstanceUID, SeriesInstanceUID or SOPInstanceUID. Example: 1.3.6.1.4.1.5962.99.1.1069745200.1645485340.1637452317744.2.0 [required]
780-
* `[TARGET]`: target directory for download [default: /Users/helmut/Library/Application Support/aignostics/datasets/idc]
780+
* `[TARGET]`: target directory for download [default: /Users/omid/Library/Application Support/aignostics/datasets/idc]
781781

782782
**Options**:
783783

@@ -816,7 +816,7 @@ $ aignostics dataset aignostics download [OPTIONS] SOURCE_URL [DESTINATION_DIREC
816816
**Arguments**:
817817

818818
* `SOURCE_URL`: URL to download. Example: gs://aignx-storage-service-dev/sample_data_formatted/9375e3ed-28d2-4cf3-9fb9-8df9d11a6627.tiff [required]
819-
* `[DESTINATION_DIRECTORY]`: Destination directory to download to [default: /Users/helmut/Library/Application Support/aignostics/datasets/aignostics]
819+
* `[DESTINATION_DIRECTORY]`: Destination directory to download to [default: /Users/omid/Library/Application Support/aignostics/datasets/aignostics]
820820

821821
**Options**:
822822

@@ -985,7 +985,7 @@ $ aignostics qupath install [OPTIONS]
985985
**Options**:
986986

987987
* `--version TEXT`: Version of QuPath to install. Do not change this unless you know what you are doing. [default: 0.6.0-rc5]
988-
* `--path DIRECTORY`: Path to install QuPath to. If not specified, the default installation path will be used.Do not change this unless you know what you are doing. [default: /Users/helmut/Library/Application Support/aignostics]
988+
* `--path DIRECTORY`: Path to install QuPath to. If not specified, the default installation path will be used.Do not change this unless you know what you are doing. [default: /Users/omid/Library/Application Support/aignostics]
989989
* `--reinstall / --no-reinstall`: Reinstall QuPath even if it is already installed. This will overwrite the existing installation. [default: reinstall]
990990
* `--platform-system TEXT`: Override the system to assume for the installation. This is useful for testing purposes. [default: Darwin]
991991
* `--platform-machine TEXT`: Override the machine architecture to assume for the installation. This is useful for testing purposes. [default: arm64]
@@ -1054,7 +1054,7 @@ $ aignostics qupath uninstall [OPTIONS]
10541054
**Options**:
10551055

10561056
* `--version TEXT`: Version of QuPath to install. If not specified, all versions will be uninstalled.
1057-
* `--path DIRECTORY`: Path to install QuPath to. If not specified, the default installation path will be used.Do not change this unless you know what you are doing. [default: /Users/helmut/Library/Application Support/aignostics]
1057+
* `--path DIRECTORY`: Path to install QuPath to. If not specified, the default installation path will be used.Do not change this unless you know what you are doing. [default: /Users/omid/Library/Application Support/aignostics]
10581058
* `--platform-system TEXT`: Override the system to assume for the installation. This is useful for testing purposes. [default: Darwin]
10591059
* `--platform-machine TEXT`: Override the machine architecture to assume for the installation. This is useful for testing purposes. [default: arm64]
10601060
* `--help`: Show this message and exit.

0 commit comments

Comments
 (0)