Skip to content

Commit

Permalink
Updating the error message
Browse files Browse the repository at this point in the history
  • Loading branch information
aritraghsh09 committed Nov 12, 2020
1 parent 9adec47 commit 5e49696
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 17 deletions.
15 changes: 10 additions & 5 deletions docs/source/api_docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,21 @@

API Documentation
=================

.. error::
**6th Oct. 2020**: Yale Astronomy's public FTP server is temporarily down. Yale
**11th Nov. 2020**: Yale Astronomy's public FTP server is temporarily down. Yale
ITS is working to restore the service as soon as possible and it should
be back online by Oct 17th.
be back online by the end of November.

During this time, tutorials that depend on pulling files from the server will
not work as expected. Besides, in your code, if you are trying to use our
trained models, this will fail as well. We apologize for this inconvenience. If your work is urgent, please reach out
to us and we can make the trained models available to you via Google Drive.
trained models, this will fail as well. We apologize for this inconvenience.

In the interim, all our trained models are available via
`Google Drive <https://drive.google.com/drive/folders/15YD88wMKZF6LRrBVIoPmNYhMLQuCYDa8?usp=sharing>`_.
This has the same file structure as the FTP server.
Please download the model you need and use the full path to the model in the ``model_load_path`` parameter.
Have a look at the :ref:`api_docs` for more information and please contact us in case you run into issues.


Both the Keras and TFLearn modules have similarly named functions with very similar parameters. Use the ``_predict_`` functions to perform
predictions using our trained models or a model you trained from scratch. Use the ``_train_`` functions to train a model from scratch. Use the
Expand Down
5 changes: 3 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,9 @@ About GaMorNet
trained models, this will fail as well. We apologize for this inconvenience.

In the interim, all our trained models are available via
`Google Drive <https://drive.google.com/drive/folders/15YD88wMKZF6LRrBVIoPmNYhMLQuCYDa8?usp=sharing>`_ .
Please download the model you need and use the full path to the model in the `model_load_path` parameter.
`Google Drive <https://drive.google.com/drive/folders/15YD88wMKZF6LRrBVIoPmNYhMLQuCYDa8?usp=sharing>`_.
This has the same file structure as the FTP server.
Please download the model you need and use the full path to the model in the ``model_load_path`` parameter.
Have a look at the :ref:`api_docs` for more information and please contact us in case you run into issues.

The Galaxy Morphology Network (GaMorNet) is a convolutional neural network that can classify galaxies as being disk-dominated, bulge-dominated or indeterminate based on their bulge to total light ratio. GaMorNet doesn't need a large amount of training data and can work across different data-sets. For more details about GaMorNet's design, how it was trained etc., please refer to :ref:`pub_and_other_data`.
Expand Down
14 changes: 9 additions & 5 deletions docs/source/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,19 @@
Tutorials
=========
.. error::
**6th Oct. 2020**: Yale Astronomy's public FTP server is temporarily down. Yale
**11th Nov. 2020**: Yale Astronomy's public FTP server is temporarily down. Yale
ITS is working to restore the service as soon as possible and it should
be back online by Oct 17th.
be back online by the end of November.

During this time, tutorials that depend on pulling files from the server will
not work as expected. Besides, in your code, if you are trying to use our
trained models, this will fail as well. We apologize for this inconvenience. If your work is urgent, please reach out
to us and we can make the trained models available to you via Google Drive.

trained models, this will fail as well. We apologize for this inconvenience.

In the interim, all our trained models are available via
`Google Drive <https://drive.google.com/drive/folders/15YD88wMKZF6LRrBVIoPmNYhMLQuCYDa8?usp=sharing>`_.
This has the same file structure as the FTP server.
Please download the model you need and use the full path to the model in the ``model_load_path`` parameter.
Have a look at the :ref:`api_docs` for more information and please contact us in case you run into issues.


We have created the following tutorials to get you quickly started with using GaMorNet. To look into the details of each GaMorNet function used in these tutorials, please look at the :ref:`api_docs`.
Expand Down
14 changes: 9 additions & 5 deletions docs/source/usage_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -167,15 +167,19 @@ To turn GaMorNet's output probability values into class predictions, we use prob
FTP Server
^^^^^^^^^^^
.. error::
**6th Oct. 2020**: Yale Astronomy's public FTP server is temporarily down. Yale
**11th Nov. 2020**: Yale Astronomy's public FTP server is temporarily down. Yale
ITS is working to restore the service as soon as possible and it should
be back online by Oct 17th.
be back online by the end of November.

During this time, tutorials that depend on pulling files from the server will
not work as expected. Besides, in your code, if you are trying to use our
trained models, this will fail as well. We apologize for this inconvenience. If your work is urgent, please reach out
to us and we can make the trained models available to you via Google Drive.

trained models, this will fail as well. We apologize for this inconvenience.

In the interim, all our trained models are available via
`Google Drive <https://drive.google.com/drive/folders/15YD88wMKZF6LRrBVIoPmNYhMLQuCYDa8?usp=sharing>`_.
This has the same file structure as the FTP server.
Please download the model you need and use the full path to the model in the ``model_load_path`` parameter.
Have a look at the :ref:`api_docs` for more information and please contact us in case you run into issues.

All components of the public data release are hosted on the Yale Astronomy FTP server ``ftp.astro.yale.edu``. There are multiple ways you can access the FTP server
and we summarize some of the methods below.
Expand Down

0 comments on commit 5e49696

Please sign in to comment.