Dean commited on
Commit
a2c34a6
1 Parent(s): 715606b

Fixing colab after feedback

Browse files
Files changed (1) hide show
  1. Notebooks/SavtaDepth_Colab.ipynb +8 -8
Notebooks/SavtaDepth_Colab.ipynb CHANGED
@@ -20,15 +20,15 @@
20
  "id": "QKUz-9qCbHRH"
21
  },
22
  "source": [
23
- "<center> <img alt=\\\"DAGsHub\\\" width=500px src=https://raw.githubusercontent.com/DAGsHub/client/master/dagshub_github.png> </center>\n",
24
  "\n",
25
  "# SavtaDepth Colab Environment\n",
26
  "\n",
27
  "### ***This notebook is meant to be run on Google Colab***\n",
28
  "\n",
29
- "This notebook is a tool to setup and orchestrate (read: Run) experiments for [SavtaDepth](https://dagshub.com/OperationSavta/SavtaDepth) on Google Colab, while maintaining a relatively clean environment and using version control to promote reproducibility. It is a WIP, but following (and modifying) the cells below should let you git clone a project into colab, download the data, run it, and push it to https://DAGsHub.com which is a free platform for open source data science. \n",
30
  "\n",
31
- "SavtaDepth is an Open Source Data Science project. We'd love to get help from the community, so if you'd like to contribute head over to the [project page](https://dagshub.com/OperationSavta/SavtaDepth) to get started."
32
  ]
33
  },
34
  {
@@ -38,7 +38,7 @@
38
  },
39
  "source": [
40
  "# General Setup\n",
41
- "Run this before anything else"
42
  ]
43
  },
44
  {
@@ -71,7 +71,7 @@
71
  "id": "xn8URgDmWBKm"
72
  },
73
  "source": [
74
- "Clone Git Repo from DAGsHub"
75
  ]
76
  },
77
  {
@@ -80,7 +80,7 @@
80
  "id": "jxOO9c2hU_zM"
81
  },
82
  "source": [
83
- "!git clone https://dagshub.com/OperationSavta/SavtaDepth.git\n",
84
  "%cd SavtaDepth/"
85
  ],
86
  "execution_count": null,
@@ -167,9 +167,9 @@
167
  "\n",
168
  "\n",
169
  "# Setup is done!\n",
170
- "If you've made it here, everything is set up. You have the code and data in the file viewer to the left. You can edit the files located in SavtaDepth/src/code/ as you like. You can see the YAML defining the project pipeline in dvc.yaml. If you change dependencies or outputs (for example, add an addition code file for the training stage), make sure you edit the pipeline to reflect this.\n",
171
  "\n",
172
- "### Once you are done with you changes run the cell below to run the pipeline end-to-end\n",
173
  "* You can run this multiple times if you've made a change and want to test it\n",
174
  "* If you want to run only a specific stage you can change the `dvc repro` command to any other command you like.\n",
175
  "\n",
 
20
  "id": "QKUz-9qCbHRH"
21
  },
22
  "source": [
23
+ "<center> <a href=\"https://dagshub.com\"><img alt=\\\"DAGsHub\\\" width=500px src=https://raw.githubusercontent.com/DAGsHub/client/master/dagshub_github.png></a> </center>\n",
24
  "\n",
25
  "# SavtaDepth Colab Environment\n",
26
  "\n",
27
  "### ***This notebook is meant to be run on Google Colab***\n",
28
  "\n",
29
+ "This notebook is a tool to setup and run experiments for [SavtaDepth](https://dagshub.com/OperationSavta/SavtaDepth) on Google Colab, while maintaining a relatively clean environment and using version control to promote reproducibility. Following (and modifying where necessary) the cells below should let you git clone a project into colab, download the data, run it, and push it to https://DAGsHub.com which is a free platform for open source data science. \n",
30
  "\n",
31
+ "SavtaDepth is an [Open Source Data Science](https://dagshub.com/blog/a-case-for-open-source-data-science/) project. We'd love to get help from the community, so if you'd like to contribute head over to the [project page](https://dagshub.com/OperationSavta/SavtaDepth) to get started."
32
  ]
33
  },
34
  {
 
38
  },
39
  "source": [
40
  "# General Setup\n",
41
+ "**Before you start, make a copy of this notebook to your Google Drive**"
42
  ]
43
  },
44
  {
 
71
  "id": "xn8URgDmWBKm"
72
  },
73
  "source": [
74
+ "Clone Git Repo from DAGsHub. **Make sure to put in your username so that you clone your version of the project**."
75
  ]
76
  },
77
  {
 
80
  "id": "jxOO9c2hU_zM"
81
  },
82
  "source": [
83
+ "!git clone https://dagshub.com/{your_dagshub_user}/SavtaDepth.git\n",
84
  "%cd SavtaDepth/"
85
  ],
86
  "execution_count": null,
 
167
  "\n",
168
  "\n",
169
  "# Setup is done!\n",
170
+ "If you've made it here, everything is set up. You have the code and data in the file viewer to the left. You can edit the files located in SavtaDepth/src/code/ as you like. You can see the YAML defining the project pipeline in dvc.yaml. If you change dependencies or outputs (for example, add an additional code file for the training stage), make sure you edit the pipeline to reflect this.\n",
171
  "\n",
172
+ "### Once you are done with your changes run the cell below to run the pipeline end-to-end\n",
173
  "* You can run this multiple times if you've made a change and want to test it\n",
174
  "* If you want to run only a specific stage you can change the `dvc repro` command to any other command you like.\n",
175
  "\n",