Dean commited on
Commit
ee797b2
1 Parent(s): 9cbee66

adding more setup options to readme

Browse files
Files changed (1) hide show
  1. README.md +11 -4
README.md CHANGED
@@ -11,6 +11,13 @@ If you'd like to take part, please follow the guide.
11
 
12
  ### Setting up your environment to contribute
13
  * To get started, fork the repository on DAGsHub
 
 
 
 
 
 
 
14
  * Next, clone the repository you just forked by typing the following command in your terminal:
15
  ```bash
16
  $ git clone https://dagshub.com/<your-dagshub-username>/SavtaDepth.git
@@ -67,7 +74,7 @@ If you'd like to take part, please follow the guide.
67
  * 🐶
68
 
69
  ### TODO:
70
- - [ ] Web UI
71
- - [ ] Testing various datasets as basis for training
72
- - [ ] Testing various models for the data
73
- - [ ] Adding qualitative tests for model performance (visually comparing 3d image outputs)
 
11
 
12
  ### Setting up your environment to contribute
13
  * To get started, fork the repository on DAGsHub
14
+ * Now, You have 3 way to set up your environment: Google Colab, local or docker. If you're not sure which one to go with, we recommend using Colab.
15
+ #### Google Colab
16
+ We can treat Colab, as your web connected, GPU powered IDE. Here is a link to a well-documented Colab notebook, that will load the code and data from this repository, enabling you to modify the code and re-run training.
17
+
18
+ **_NOTE: The downside of this method (if you are not familiar with Colab) is that Google Colab will limit the amount of time an instance can be live, so you might be limited in your ability to train models for longer periods of time.
19
+ #### Local
20
+ #### Docker
21
  * Next, clone the repository you just forked by typing the following command in your terminal:
22
  ```bash
23
  $ git clone https://dagshub.com/<your-dagshub-username>/SavtaDepth.git
 
74
  * 🐶
75
 
76
  ### TODO:
77
+ [ ] Web UI
78
+ [ ] Testing various datasets as basis for training
79
+ [ ] Testing various models for the data
80
+ [ ] Adding qualitative tests for model performance (visually comparing 3d image outputs)