diff --git a/README.md b/README.md index 2fcb42c..9bfbd38 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ In this exercise we will build a simple model that can predict the carbon dioxide uptake in MOFs. The goal is to get familiar with the tools that are used for machine learning and to develop an understanding of the workflow, tricks, and pitfalls (e.g., why baselines are important). Some more of the theory can be found [in our review](https://pubs.acs.org/doi/abs/10.1021/acs.chemrev.0c00004). -![Parity plot result](_static/result.gif) +![Parity plot result](assests/result.gif) If you find some errors, typos or issues feel free to [open an issue](https://help.github.com/en/github/managing-your-work-on-github/about-issues) or directly make a [pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests). @@ -61,20 +61,20 @@ jupyter lab Make sure that the notebook kernel runs in the correct environment: -![Environment name](_static/conda_env_name.png) +![Environment name](assests/conda_env_name.png) If the environment name that is shown is different from "ml_molsim" you can click on it and select the correct one. ## Use it on Google Colab -![Screenshot of the Colab environment](_static/colab.png) +![Screenshot of the Colab environment](assests/colab.png) Here, you can use relatively powerful computing resources (like [GPUs](https://en.wikipedia.org/wiki/Graphics_processing_unit) and [TPUs](https://en.wikipedia.org/wiki/Tensor_Processing_Unit)) from Google for free. Click the "Open in Colab" button on the top, then make a copy of the notebook into your Google Drive, and run the first three cells to install the dependencies. Then you should be able to use the notebook in Colab. -![Making a copy in Colab](_static/save_copy_colab.png) +![Making a copy in Colab](assests/save_copy_colab.png) **Make sure to make a copy into your Google Drive and work on this copy. And not on the shared notebook!** diff --git a/_static/404error.png b/assets/404error.png similarity index 100% rename from _static/404error.png rename to assets/404error.png diff --git a/_static/colab.png b/assets/colab.png similarity index 100% rename from _static/colab.png rename to assets/colab.png diff --git a/_static/conda_env_name.png b/assets/conda_env_name.png similarity index 100% rename from _static/conda_env_name.png rename to assets/conda_env_name.png diff --git a/_static/kaggle_upload.png b/assets/kaggle_upload.png similarity index 100% rename from _static/kaggle_upload.png rename to assets/kaggle_upload.png diff --git a/_static/kernel_example.png b/assets/kernel_example.png similarity index 100% rename from _static/kernel_example.png rename to assets/kernel_example.png diff --git a/_static/kernel_mapping.png b/assets/kernel_mapping.png similarity index 100% rename from _static/kernel_mapping.png rename to assets/kernel_mapping.png diff --git a/_static/mof_building_principle.png b/assets/mof_building_principle.png similarity index 100% rename from _static/mof_building_principle.png rename to assets/mof_building_principle.png diff --git a/_static/racs.png b/assets/racs.png similarity index 100% rename from _static/racs.png rename to assets/racs.png diff --git a/_static/result.gif b/assets/result.gif similarity index 100% rename from _static/result.gif rename to assets/result.gif diff --git a/_static/save_copy_colab.png b/assets/save_copy_colab.png similarity index 100% rename from _static/save_copy_colab.png rename to assets/save_copy_colab.png diff --git a/_static/spheres.png b/assets/spheres.png similarity index 100% rename from _static/spheres.png rename to assets/spheres.png