Page Comparison

...

1. If you haven’t already, download and install Git: https://git-scm.com/

   1. Git should already be installed on Linux and MacOS.

2. Windows (Linux and MacOS users skip step): Ensure core.autocrlf is set to true or input . Line endings on GitHub are LF only, not CRLF!

   1. Check: git config --get core.autocrlf .

   2. Set: git config --global core.autocrlf [setting] .

      1. --global is optional, and replace [setting] with the desired setting (true or input ).

      2. When in doubt, use input.

   3. Additional information here: https://www.git-scm.com/book/en/v2/Customizing-Git-Git-Configuration#_core_autocrlf

3. Configure Git with your name and email: https://linuxize.com/post/how-to-configure-git-username-and-email/

   • --global if you want to use it as the default, otherwise it will just be for the current repository.

   • You can use your anonymous GitHub no-reply email.

4. Go to GitHub and navigate to your copy of the repository, under your account. Do not go to WARG’s copy of the repository!

5. Click on the green Code button.

6. In the dropdown, you can copy either the HTTPS or SSH link.

   1. Windows and MacOS: Copy the HTTPS link (although you can copy the SSH link if you desire).

   2. Linux: Copy the SSH link.

      1. If you really want to use HTTPS on Linux, you have to install the Git Credential Manager or create a Personal Access Token on GitHub. How to do this is left as an exercise for the bootcamper.

7. If you’re using the SSH link (HTTPS link users can skip this):

   1. If you haven’t already, create a new SSH key and add it to your GitHub account:

      1. https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent

      2. https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account

8. Pick a parent directory to clone into.

   1. Example: Cloning in C:\Users\Username\ will create a folder and then populate it: C:\Users\Username\autonomy-bootcamp-2023\[bootcamp stuff]

9. Open a terminal in the parent directory.

   1. Windows: Command prompt or Powershell.

   2. Linux and MacOS: Terminal.

10. Run: git clone [link you copied] , where [link you copied] is the link you copied in step 5.

    1. HTTPS link users: You will be prompted to log into your GitHub account. Do so.

11. Done!

...

1. If you haven’t already, download and install Python 3.8: https://www.python.org/

   1. If you already have Python 3.7 or below installed, you must install Python 3.8 (you do not need to uninstall the other version(s)). This is because of a package dependency which requires Python 3.8 or greater.

   2. If you have Python 3.9 or above installed, you’re probably fine. Probably. The bootcamp was designed and tested on Python 3.8 so use a different version at your own risk.

2. Open a terminal in the repository root.

   1. Example: C:\Users\Username\autonomy-bootcamp-2023

3. Create a virtual environment called venv by running: [python] -m venv venv/ , where [python] is Python 3.8 (e.g. python , python38 ).

   1. You can check which version of Python it is by running [python] --version .

   2. If you move the repository to a different path after creating a virtual environment, you will have to delete the venv directory and repeat this step.

   3. If you want to call the virtual environment by a different name, replace venv/ with the name you want. Virtual environments are identified by their path, so different projects with the same venv virtual environment name is fine.

      1. Example: C:\Users\Username\autonomy-bootcamp-2023\venv\ and C:\Users\Username\computer-vision-python\venv\ are different.

4. Activate the virtual environment:

   1. Windows command prompt: venv\Scripts\activate.bat

   2. Windows Powershell: .\venv\Scripts\Activate.ps1

   3. Linux and MacOS: source venv/bin/activate

5. You should now see (venv) in the prompt line.

6. Confirm the version of Python in your virtual environment uses Python 3.8: python --version .

   1. Literally use python , none of the fancy stuff above.

   2. Example output: Python 3.8.10

7. Open requirements.txt .

   1. MacOS: Remove +cu117 from both torch and torchvision .

   2. Everyone elseWindows and Linux:

      1. If you have a CUDA capable GPU but don’t want to use it for some reason, change +cu117 to +cpu for both torch and torchvision .

      2. If you don’t have a CUDA capable GPU, don’t change anything.

8. Download and install required packages: pip install -r requirements.txt

   1. This will install in your virtual environment under venv . The rest of your system is unaffected.

9. Done!

...

...

Once your submission is ready for review, open a pull request (PR) from your fork to the WARG repository.

...

...