added instructions for reseting any play-around changes when installing the template

Author: nakytoe

README.md

@@ -530,11 +530,17 @@ So, after deciding which editor you are working with (Azure ML default notebook
     # do not add comment to same line with a magic command:
     %load_ext nb_black #this comment breaks the magic command
 
-8. Check that you can run the notebooks `00_data.ipynb`, `01_model.ipynb` and `02_loss.ipynb`.
+8. Check that you can run the notebooks `00_data.ipynb`, `01_model.ipynb`, `02_loss.ipynb` and `03_workflow.ipynb`.
 You may have to change the kernel your notebook interpreter is using to the one you just created.
 This can be done drop down bar in top of the notebook editor. You can play around with the notebooks to better understand the structure and the examples.
 
-9. Replace the notebooks `index`, `data`, `model`, `loss` and `workflow` with copies without the code examples (there is also additional empty notebook template `_XX_empty_notebook_template.ipynb` if you want to deviate from basic template structure):
+9. If while getting to know the template examples you ran or edited any of the notebooks, run the following command to clean any unrelevant changes.
+
+    git reset --hard
+
+Please note, that this will reset any changes made to the template. We do this to clean any 'play-around' work you might have done getting to know the template and the examples.
+
+10. Replace the notebooks `index`, `data`, `model`, `loss` and `workflow` with copies without the code examples (there is also additional empty notebook template `_XX_empty_notebook_template.ipynb` if you want to deviate from basic template structure):
 
 
     git rm index.ipynb 00_data.ipynb 01_model.ipynb 02_loss.ipynb 03_workflow.ipynb
@@ -544,36 +550,36 @@ This can be done drop down bar in top of the notebook editor. You can play aroun
     git mv notebook_templates/_02_loss.ipynb ./02_loss.ipynb
     git mv notebook_templates/_03_workflow.ipynb ./03_workflow.ipynb
 
-10. You may delete the folders `ml_project_template`, `notebook_templates` and `visuals`.
+11. You may delete the folders `ml_project_template`, `notebook_templates` and `visuals`.
 
 
     git rm -r ml_project_template notebook_templates visuals docs/visuals
 
-11. Edit `settings.ini`, `docs/_config.yml` and `docs/_data/topnav.yml` according to your project details.
+12. Edit `settings.ini`, `docs/_config.yml` and `docs/_data/topnav.yml` according to your project details.
 The files contain instructions for minimum required edits.
 You can continue editing them in the future, so no need to worry about getting it right the first time.
 These are used for building the python modules and docs based on your notebooks.
 If you get errors when building a module or docs, take a look again at these files.
 
-12. The Helsinki logo is a registered trademark, and may only be used by the city of Helsinki.
+13. The Helsinki logo is a registered trademark, and may only be used by the city of Helsinki.
 If you are using this template for other than city of Helsinki projects, remove the files `favicon.ico` and `company_logo.png` from `docs/assets/images/`.
 You may replace these with your own logo. Fast.ai logo will show in documentation if custom logos are not defined.
 
-13. Recreate the module and doc pages to clean them: `nbdev_build_lib && nbdev_build_docs`
+14. Recreate the module and doc pages to clean them: `nbdev_build_lib && nbdev_build_docs`
 
-14. Configure your git user name and email adress (one of those added to your git account) if you haven't done it already:
+15. Configure your git user name and email adress (one of those added to your git account) if you haven't done it already:
 
 
     git config --global user.name "FIRST_NAME LAST_NAME"
     git config --global user.email "MY_NAME@example.com"
 
-15. Make initial commit (snapshot of the code as it is when you begin the work):
+16. Make initial commit (snapshot of the code as it is when you begin the work):
 
 
     git add .
     git commit -m "Initial commit"
 
-16. Push (save changes to remote repository): `git push -u origin master`. You will be asked to log in with your SSH key and password, again.
+17. Push (save changes to remote repository): `git push -u origin master`. You will be asked to log in with your SSH key and password, again.
 
 
 ## How to use

docs/index.html

@@ -528,13 +528,18 @@ <h3 id="2.-On-your-computing-environment:">2. On your computing environment:<a c
 
 </code></pre>
 <ol>
-<li><p>Check that you can run the notebooks <code>00_data.ipynb</code>, <code>01_model.ipynb</code> and <code>02_loss.ipynb</code>.
+<li><p>Check that you can run the notebooks <code>00_data.ipynb</code>, <code>01_model.ipynb</code>, <code>02_loss.ipynb</code> and <code>03_workflow.ipynb</code>.
 You may have to change the kernel your notebook interpreter is using to the one you just created.
 This can be done drop down bar in top of the notebook editor. You can play around with the notebooks to better understand the structure and the examples.</p>
 </li>
-<li><p>Replace the notebooks <code>index</code>, <code>data</code>, <code>model</code>, <code>loss</code> and <code>workflow</code> with copies without the code examples (there is also additional empty notebook template <code>_XX_empty_notebook_template.ipynb</code> if you want to deviate from basic template structure):</p>
+<li><p>If while getting to know the template examples you ran or edited any of the notebooks, run the following command to clean any unrelevant changes.</p>
+<p>git reset --hard</p>
 </li>
 </ol>
+<p>Please note, that this will reset any changes made to the template. We do this to clean any 'play-around' work you might have done getting to know the template and the examples.</p>
+<ol>
+<li>Replace the notebooks <code>index</code>, <code>data</code>, <code>model</code>, <code>loss</code> and <code>workflow</code> with copies without the code examples (there is also additional empty notebook template <code>_XX_empty_notebook_template.ipynb</code> if you want to deviate from basic template structure):</li>
+</ol>
 
 <pre><code>git rm index.ipynb 00_data.ipynb 01_model.ipynb 02_loss.ipynb 03_workflow.ipynb
 git mv notebook_templates/_index.ipynb ./index.ipynb

index.ipynb

@@ -615,11 +615,17 @@
     "    # do not add comment to same line with a magic command:\n",
     "    %load_ext nb_black #this comment breaks the magic command\n",
     "\n",
-    "8. Check that you can run the notebooks `00_data.ipynb`, `01_model.ipynb` and `02_loss.ipynb`.\n",
+    "8. Check that you can run the notebooks `00_data.ipynb`, `01_model.ipynb`, `02_loss.ipynb` and `03_workflow.ipynb`.\n",
     "You may have to change the kernel your notebook interpreter is using to the one you just created.\n",
     "This can be done drop down bar in top of the notebook editor. You can play around with the notebooks to better understand the structure and the examples.\n",
     "\n",
-    "9. Replace the notebooks `index`, `data`, `model`, `loss` and `workflow` with copies without the code examples (there is also additional empty notebook template `_XX_empty_notebook_template.ipynb` if you want to deviate from basic template structure):\n",
+    "9. If while getting to know the template examples you ran or edited any of the notebooks, run the following command to clean any unrelevant changes.\n",
+    "\n",
+    "    git reset --hard\n",
+    "\n",
+    "Please note, that this will reset any changes made to the template. We do this to clean any 'play-around' work you might have done getting to know the template and the examples.\n",
+    "\n",
+    "10. Replace the notebooks `index`, `data`, `model`, `loss` and `workflow` with copies without the code examples (there is also additional empty notebook template `_XX_empty_notebook_template.ipynb` if you want to deviate from basic template structure):\n",
     "\n",
     "\n",
     "    git rm index.ipynb 00_data.ipynb 01_model.ipynb 02_loss.ipynb 03_workflow.ipynb\n",
@@ -629,36 +635,36 @@
     "    git mv notebook_templates/_02_loss.ipynb ./02_loss.ipynb\n",
     "    git mv notebook_templates/_03_workflow.ipynb ./03_workflow.ipynb\n",
     "\n",
-    "10. You may delete the folders `ml_project_template`, `notebook_templates` and `visuals`.\n",
+    "11. You may delete the folders `ml_project_template`, `notebook_templates` and `visuals`.\n",
     "\n",
     "\n",
     "    git rm -r ml_project_template notebook_templates visuals docs/visuals\n",
     "\n",
-    "11. Edit `settings.ini`, `docs/_config.yml` and `docs/_data/topnav.yml` according to your project details.\n",
+    "12. Edit `settings.ini`, `docs/_config.yml` and `docs/_data/topnav.yml` according to your project details.\n",
     "The files contain instructions for minimum required edits.\n",
     "You can continue editing them in the future, so no need to worry about getting it right the first time.\n",
     "These are used for building the python modules and docs based on your notebooks.\n",
     "If you get errors when building a module or docs, take a look again at these files.\n",
     "\n",
-    "12. The Helsinki logo is a registered trademark, and may only be used by the city of Helsinki.\n",
+    "13. The Helsinki logo is a registered trademark, and may only be used by the city of Helsinki.\n",
     "If you are using this template for other than city of Helsinki projects, remove the files `favicon.ico` and `company_logo.png` from `docs/assets/images/`.\n",
     "You may replace these with your own logo. Fast.ai logo will show in documentation if custom logos are not defined.\n",
     "\n",
-    "13. Recreate the module and doc pages to clean them: `nbdev_build_lib && nbdev_build_docs`\n",
+    "14. Recreate the module and doc pages to clean them: `nbdev_build_lib && nbdev_build_docs`\n",
     "\n",
-    "14. Configure your git user name and email adress (one of those added to your git account) if you haven't done it already:\n",
+    "15. Configure your git user name and email adress (one of those added to your git account) if you haven't done it already:\n",
     "\n",
     "\n",
     "    git config --global user.name \"FIRST_NAME LAST_NAME\"\n",
     "    git config --global user.email \"MY_NAME@example.com\"\n",
     "\n",
-    "15. Make initial commit (snapshot of the code as it is when you begin the work):\n",
+    "16. Make initial commit (snapshot of the code as it is when you begin the work):\n",
     "\n",
     "\n",
     "    git add .\n",
     "    git commit -m \"Initial commit\"\n",
     "\n",
-    "16. Push (save changes to remote repository): `git push -u origin master`. You will be asked to log in with your SSH key and password, again.\n"
+    "17. Push (save changes to remote repository): `git push -u origin master`. You will be asked to log in with your SSH key and password, again.\n"
    ]
   },
   {
@@ -778,9 +784,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3.8 (templateenv)",
+   "display_name": "Python 3.8 - AzureML",
    "language": "python",
-   "name": "templateenv_py3.8.1"
+   "name": "python38-azureml"
   }
  },
  "nbformat": 4,