doc update

supernnova · Oct 28, 2024 · 7843343 · 7843343
1 parent b4e5baa
commit 7843343
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 46 deletions.
diff --git a/README.md b/README.md
@@ -46,7 +46,11 @@ To reproduce the Dark Energy Survey analyses use commit `fcf8584b64974ef7a238eac
 
 To reproduce Fink analyses until 2024 use commit `fcf8584b64974ef7a238eac718e01be4ed637a1d` and check [Fink's github](https://github.com/astrolabsoftware/fink-science).
 
-## Build docs <a name="docs"></a>
+### Build docs <a name="docs"></a>
 
     cd docs && make clean && make html && cd ..
     firefox docs/_build/html/index.html
+
+
+### ADACS
+This package has been updated to a recent pytorch through the [ADACS Merit allocation program](https://adacs.org.au/merit-allocation-program) 2023-2024.
diff --git a/docs/configuration/index.rst b/docs/configuration/index.rst
@@ -61,7 +61,7 @@ Visualization Parameters
 Argument                          Type                Help
 ===============================  ============  ==========================================================
 --explore_lightcurves             bool         Plot a random selection of lightcurves
---plot_lcs                        bool         Plot a random selection of lightcurves  predictions
+--plot_lcs                        bool         Plot a random selection of lightcurves  predictions 
 --plot_prediction_distribution    bool         Plot lcs and the histogram of probability for each class
 ===============================  ============  ==========================================================
 

diff --git a/docs/data/index.rst b/docs/data/index.rst
@@ -152,13 +152,13 @@ e.g. ``--redshift_label REDSHIFT_FINAL``.
 
 8. Use a different sntype label
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The default sntype label is ``SNTYPE``. If you want to use your own label, you'll need to specify it. 
+The default sntype label is ``SNTYPE``. If you want to use your own label, you'll need to specify it and provide it in the `HEAD` file.
 
 .. code-block:: bash
 
     snn make_data --dump_dir <path/to/save/database/> --raw_dir <path/to/raw/data/>  --sntype_var <your/label>
 
-e.g. ``--redshift_label SIM_SNTYPE``. 
+e.g. ``--sntype_var MYTYPE``. 
 
 9. Mask photometry
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/docs/visualization/index.rst b/docs/visualization/index.rst
@@ -74,7 +74,7 @@ Below is a sample plot:
 
 .. image:: preds_variational.png
 
-
+Beware: only MC Dropout (variational) and Bayes by Backprop (bayesian) models have this feature.
 
 Predictions from multiple models
 -------------------------------------------

diff --git a/run_yml.py b/run_yml.py
-Original file line number
+Diff line change
@@ Expand Up / @@ -74,7 +74,7 @@ Below is a sample plot: @@
     .. image:: preds_variational.png
+    Beware: only MC Dropout (variational) and Bayes by Backprop (bayesian) models have this feature.
     Predictions from multiple models
     -------------------------------------------
@@ Expand Down @@