Skip to content

Commit 14dd0e2

Browse files
Updating quick-start
Signed-off-by: João Lucas de Sousa Almeida <[email protected]>
1 parent 908cde8 commit 14dd0e2

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/quick_start.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
We suggest using Python==3.10.
33
To get started, make sure to have `PyTorch >= 2` [installed](https://pytorch.org/get-started/locally/).
44

5-
Install TerraTorch with `pip install git+https://github.com/IBM/terratorch.git`
5+
For a stable point-release, use `pip install terratorch`.
6+
If you prefer to get the most recent version of the main branch, install the library with `pip install git+https://github.com/IBM/terratorch.git`.
67

78
To install as a developer (e.g. to extend the library) clone this repo, and run `pip install -e .`.
89

@@ -233,4 +234,4 @@ To run this training task, simply execute `terratorch fit --config <path_to_conf
233234

234235
To test your model on the test set, execute `terratorch test --config <path_to_config_file> --ckpt_path <path_to_checkpoint_file>`
235236

236-
For inference, execute `terratorch predict -c <path_to_config_file> --ckpt_path<path_to_checkpoint> --predict_output_dir <path_to_output_dir> --data.init_args.predict_data_root <path_to_input_dir> --data.init_args.predict_dataset_bands <all bands in the predicted dataset, e.g. [BLUE,GREEN,RED,NIR_NARROW,SWIR_1,SWIR_2,0]>`
237+
For inference, execute `terratorch predict -c <path_to_config_file> --ckpt_path<path_to_checkpoint> --predict_output_dir <path_to_output_dir> --data.init_args.predict_data_root <path_to_input_dir> --data.init_args.predict_dataset_bands <all bands in the predicted dataset, e.g. [BLUE,GREEN,RED,NIR_NARROW,SWIR_1,SWIR_2,0]>`

0 commit comments

Comments
 (0)