Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating installation guide #10

Merged
merged 4 commits into from
May 24, 2024
Merged

Updating installation guide #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
908cde8
Updating installation guide
Joao-L-S-Almeida May 22, 2024
2276cc8
Merge branch 'main' into extend/docs
Joao-L-S-Almeida May 22, 2024
14dd0e2
Updating quick-start
Joao-L-S-Almeida May 23, 2024
93da325
Merge branch 'extend/docs' of github.com:IBM/terratorch into extend/docs
Joao-L-S-Almeida May 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ The library provides:
### Pip
In order to use th file `pyproject.toml` it is necessary to guarantee `pip>=21.8`. If necessary upgrade `pip` using `python -m pip install --upgrade pip`.

Install the library with `pip install git+https://github.com/IBM/terratorch.git`.
For a stable point-release, use `pip install terratorch`.
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`.

TerraTorch requires gdal to be installed, which can be quite a complex process. If you don't have GDAL set up on your system, we reccomend using a conda environment and installing it with `conda install -c conda-forge gdal`.

Expand Down
5 changes: 3 additions & 2 deletions docs/quick_start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ To get started, make sure to have [PyTorch](https://pytorch.org/get-started/loca

Installing GDAL can be quite a complex process. If you don't have GDAL set up on your system, we reccomend using a conda environment and installing it with `conda install -c conda-forge gdal`.

Install TerraTorch with `pip install git+https://github.com/IBM/terratorch.git`
For a stable point-release, use `pip install terratorch`.
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`.

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

Expand Down Expand Up @@ -235,4 +236,4 @@ To run this training task, simply execute `terratorch fit --config <path_to_conf

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

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]>`
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]>`
Loading