update README comments on DECam model

profjsb · Oct 2, 2019 · 8d98403 · 8d98403
1 parent affd13d
commit 8d98403
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -23,12 +23,16 @@ link to this repository.
 ### New for v0.2.0
 
 [DECam](https://deepcr.readthedocs.io/en/latest/model_zoo.html#decam) deepCR model now available!
+
 ```python
 from deepCR import deepCR
 decam_model = deepCR(mask='decam', device='CPU')
-acswfc_model = deepCR(mask='ACS-WFC-F606W-2-32', inpaint='ACS-WFC-F606W-2-32', device='GPU')
 ```
-Note: Inpainting model is TBA for DECam.
+Note 1: Model is trained on g-band images but is expected to work on 
+other filters as well. We are working on benchmarking on different filters 
+but before that's done please proceed with caution working with other filters.
+
+Note 1: Inpainting model is TBA for DECam.
 
 ### Installation
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -36,7 +36,7 @@ Or you can install from source:
 
    git clone https://github.com/profjsb/deepCR.git
    cd deepCR/
-   pip install
+   python setup.py install
 
 Currently available models
 ^^^^^^^^^^^^^^^^^^^^^^^^^^

diff --git a/docs/model_zoo.rst b/docs/model_zoo.rst
@@ -36,6 +36,10 @@ Input images should come from calibrated images in the original unit (adu).
 The ROC curves above are produced from a test set that contains noise in cosmic ray labels.
 This causes TPR to be lower than actual because the deepCR predicted CR labels is essentially noise-free.
 
+Model is trained on g-band images but is expected to work on
+other filters as well. We are working on benchmarking on different filters
+but before that's done please proceed with caution working with other filters.
+
 For extremely short or long exposures (t_exp < 10s or t_exp > 1800s), please visually verify mask output.
 
 Generic Ground Imaging