Instruction for installation in Windows #216
Conversation
docs/Docker-install-windows.md
Outdated
| docker exec -it api bash | ||
| ``` | ||
|
|
||
| Once bash is promoted run the following commands, one at a time: ***TODO*** How do we know when bash is promoted? What does "promoted" mean in this context? |
There was a problem hiding this comment.
When you see new screen saying welcome . its a terminal inside docker container !
docs/Docker-install-windows.md
Outdated
| - Create environment variable TRAINING_WORKSPACE | ||
|
|
||
| Training workspace is the directory where fAIr will store its training files | ||
| for example. ***TODO*** Is this about a new checkpoint after fine-tuning? The name implies that this is for temporary files. |
There was a problem hiding this comment.
This is about a base folder where all information about training will be saved including checkpoints , It will also save preprocessed data & labels.geojson
docs/Docker-install-windows.md
Outdated
| nvidia-smi | ||
| ``` | ||
|
|
||
| You need to see your graphics card details here. ***TODO*** Does this mean that if this command shows details about my GPU, then it is OK for fAIr? |
There was a problem hiding this comment.
Yes if it shows details about your GPU that means you can use your nvidia graphics to fAIr which is ideal
docs/Docker-install-windows.md
Outdated
|
|
||
| 1. Check your graphics card | ||
|
|
||
| It is highly recommended to use a graphics card to run fAIr. It might not work with CPU only. (You can set up and test from bottom of this document). ***TODO*** What does this mean? NVIDIA graphics cards are tested. The bottom of this document is about a tile server, whatever that is. But it is not a GPU test?! ***TODO*** Does this mean that it works for NVIDIA cards but not for cards from other brands? |
There was a problem hiding this comment.
Tile server is different , this is solely meant for serving your local geotiff to fAIr Read more here : https://developmentseed.org/titiler/
On this doc , When we say NVIDIA cards are tested it means : Developers have tested fAIr with NVIDIA Graphics . fAIr basemodels might not work with other graphics or might work we haven't tested them yet.
It doesn't mean it won't work , it can solely be setup in CPU only too but may not be ideal for trainings ! I am pretty sure to be able to setup basemodels like RAMP in other graphics card will be hell of pain
There was a problem hiding this comment.
At least normally, I put the TODO comments after the text that I think is problematic. Here my problem is with the text "(You can set up and test from bottom of this document)." To me it looks like it is saying "At the bottom of this text there is an instruction for how to set up and test your graphics card." But there is no such instruction at the bottom of this text. So I am clueless, and I think many other readers will also find this difficult to understand.
(I understand the other part.)
There was a problem hiding this comment.
You are right , we can include following link for setup https://www.nvidia.com/Download/index.aspx
For testing nvidia-smi will be enough if it returns you have set up your drivers correctly if not either you don't have graphics card or drivers are not setup
|
This is nice @Ettrig ! Can you verify this completely works on windows on clean installation ? Once you verify that I can merge this PR ! |
|
I followed it verbatim, to the best of my ability. It took 29 minutes. It worked. I did not install Docker. I did not do new setup in OSM. |
Existing instruction Docker-installation.md is not fully compatible with Windows. This PR adds adds an instruction that is.