Instructions and rename

GilesStrong · Feb 10, 2020 · 8ef6083 · 8ef6083
1 parent 644680f
commit 8ef6083
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -113,6 +113,7 @@ Several examples are present in the form of Jupyter Notebooks in the `examples`
 1. [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/GilesStrong/lumin/blob/v0.4.0.1/examples/Feature_Selection.ipynb) `examples/Feature_Selection.ipynb`: In-depth walkthrough for automated feature-selection
 1. [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/GilesStrong/lumin/blob/v0.4.0.1/examples/Advanced_Model_Building.ipynb) `examples/Advanced_Model_Building.ipynb`: In-depth look at building more complicated models and a few advanced interpretation techniques
 1. [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/GilesStrong/lumin/blob/v0.4.0.1/examples/Model_Exporting.ipynb) `examples/Model_Exporting.ipynb`: Walkthough for exporting a trained model to ONNX and TensorFlow
+1. [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/GilesStrong/lumin/blob/v0.4.0.1/examples/RNNs_CNNs_and_GNNs_for_matrix_data.ipynb) `examples/RNNs_CNNs_and_GNNs_for_matrix_data.ipynb.ipynb`: Various examples of applying RNNs, CNNs, and GNNs to matrix data (top-tagging on jet constituents)
 
 ## Installation
 

diff --git a/build.md b/build.md
@@ -1,5 +1,13 @@
-# Pypi build instructions
+# Release Steps
+
+1. Run examples and fix errors
+1. Check an example on Google Colab
+1. Follow instructions in docs/build.md
 1. Run: python setup.py sdist bdist_wheel
 1. Run. twine upload --repository-url https://test.pypi.org/legacy/ dist/*
 1. Test: pip install -i https://test.pypi.org/simple/ lumin
-1. Release: twine upload dist/*
+1. Release: twine upload dist/*
+1. Update Colab example links to upcoming version
+1. Make github release
+1. Increment lumin.version.py
+1. Add build to readthedocs and check docs
diff --git a/docs/build.md b/docs/build.md
@@ -2,4 +2,8 @@
 
 1. Run: sphinx-apidoc -l -o source/ ../lumin ../lumin/*abs_* ../lumin/utils/mod_ver.py -f
 1. Change toctree max depth to 1 in source files
+1. Ensure TOC in source/index.rst is up to date
+1. Replace contents of source/description.md with relevant sections from ../README.md
 1. Run: make html
+1. Open _build/html/index.html and check
+1. Push changes and check build readthedocs build progress
diff --git a/...les/RNNs_CNN_&_GNNs_for_matrix_data.ipynb → .../RNNs_CNNs_and_GNNs_for_matrix_data.ipynb b/...les/RNNs_CNN_&_GNNs_for_matrix_data.ipynb → .../RNNs_CNNs_and_GNNs_for_matrix_data.ipynb