Update setup docs #1563
Merged
Update setup docs #1563
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is needed if running directly on an EC2 instance or on a Mac.
AdeelH
approved these changes
Nov 28, 2022
docs/setup.rst
Outdated
Comment on lines
19
to
23
| This has been shown to work in the following environment. Variations on this environment may or may not work. | ||
| * Ubuntu Linux 20.04 | ||
|
|
||
| * Python 3.9 | ||
|
|
||
| * CUDA 11.6 and NVIDIA Driver 510.47.03 (for GPU support) |
There was a problem hiding this comment.
rst requires a blank line before the bullet list starts. Also there shouldn't be new lines between list items.
docs/setup.rst
Outdated
|
|
||
| Raster Vision also runs on macOS version 12.1, except that the ``num_workers`` for the ``DataLoader`` will need to be set to 0 due to an issue with mulitprocessing on Macs with Python >= 3.8. It will also be necessary to install GDAL 3.5.2 prior to installing Raster Vision, which isn't necessary on Linux. | ||
|
|
||
| Raster Vision has not been tested with Windows, and will probably run into problems. |
There was a problem hiding this comment.
Raster Vision has not been tested with Windows, and will probably run into problems.
Might want to put this in a warning box.
|
|
||
| The simplest way to run Raster Vision on an AWS GPU is by starting a GPU-enabled EC2 instance such as a p3.2xlarge using the `Deep Learning AMI <https://aws.amazon.com/machine-learning/amis/>`_. We have tested this using the "Deep Learning AMI GPU PyTorch 1.11.0 (Ubuntu 20.04)" with id ``ami-0c968d7ef8a4b0c34``. After SSH'ing into the instance, Raster Vision can be installed with ``pip``, and code can be transfered to this instance with a tool such as ``rsync``. | ||
|
|
||
| .. _aws batch setup: |
There was a problem hiding this comment.
The reference from line 183 to this subsection is broken.
|
It might also make sense to move the |
* Prioritizes pip setup over Docker * Adds more information on the environment needed to directly run RV without Docker * Adds instructions on running on EC2 instance * Some minor reorganization
Codecov Report
@@ Coverage Diff @@
## master #1563 +/- ##
==========================================
- Coverage 75.78% 75.73% -0.05%
==========================================
Files 193 193
Lines 9226 9229 +3
==========================================
- Hits 6992 6990 -2
- Misses 2234 2239 +5
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
This PR updates the setup docs to clarify the environment needed to install RV using pip, and describes how to run it directly on EC2 among some other changes.
Notes
I was able to install and run directly on a Mac without using Docker, except for an inability to use
num_workers > 0which I was unable to easily fix. See #1562Closes #1542