Add acknowledgments, bump to v1.0.0

README.md

@@ -6,10 +6,6 @@ Code for our ICML 2019 paper:
 **[Probabilistic Neural-Symbolic Models for Interpretable Visual Question Answering][1]**  
 Ramakrishna Vedantam, Karan Desai, Stefan Lee, Marcus Rohrbach, Dhruv Batra, Devi Parikh
 
-  * [Training](#training)
-  * [Evaluation](#evaluation)
-  * [Pretrained Checkpoint](#pretrained-checkpoint)
-
 Checkout our package documentation at
 [kdexd.github.io/probnmn-clevr](https://kdexd.github.io/probnmn-clevr)!
 
@@ -26,12 +22,40 @@ If you find this code useful, please consider citing:
 }
 ```
 
-**Refer documentation for specific usage instructions:**
+Usage Instructions
+------------------
 
 1. [How to setup this codebase?][2]
 2. [How to train your ProbNMN?][3]
 3. [How to evaluate or run inference?][4]
 
+
+Pre-trained Checkpoint
+----------------------
+
+Pre-trained checkpoints and corresponding config files (with all the
+hyper-parameters) for all training phases is available with v1.0 release of
+this repository. Check out the [Releases](https://github.com/kdexd/probnmn-clevr/releases)!
+
+
+Acknowledgments
+---------------
+
+We thank the developers of:
+
+1. [@davidmascharka/tbd-nets](https://www.github.com/davidmascharka/tbd-nets)
+   for providing a very clean implementation of our core Neural Module Network.
+
+2. [@allenai/allennlp](https://www.github.com/allenai/allennlp) for providing
+   an awesome framework which indeed takes _masking and padding seriously._ 
+
+3. [@rbgirshick/yacs](https://www.github.com/rbgirshick/yacs) for providing an
+   efficient package-wide configuration management.
+
+4. [@pytorch/pytorch](https://www.github.com/pytorch/pytorch), this needs no
+   reason.
+
+
 [1]: https://arxiv.org/abs/1902.07864
 [2]: https://kdexd.github.io/probnmn-clevr/probnmn/usage/setup_dependencies.html
 [3]: https://kdexd.github.io/probnmn-clevr/probnmn/usage/training.html

docs/conf.py

@@ -61,9 +61,9 @@
 # built documents.
 #
 # This version is used underneath the title on the index page.
-version = "0.1"
+version = "1.0.0"
 # The following is used if you need to also include a more detailed version.
-release = "0.1"
+release = "1.0.0"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/index.rst

@@ -9,6 +9,8 @@ Probabilistic Neural-symbolic Models
 .. image:: _static/probnmn_model.jpg
 
 
+Get the source at `@kdexd/probnmn-clevr <https://www.github.com/kdexd/probnmn-clevr>`_.
+
 If you find this code useful, please consider citing:
 
 .. code-block:: text

setup.py

@@ -4,10 +4,10 @@
 
 setup(
     name="probnmn",
-    version="0.1.0",
+    version="1.0.0",
     author="Karan Desai",
-    description="Experiments for ICML 2019 Submission: 'Probabilistic Neural-symbolic Models "
-                "for Interpretable Visual Question Answering' on CLEVR v1.0 dataset.",
+    description="Code for ICML 2019 Paper: 'Probabilistic Neural-symbolic Models "
+                "for Interpretable Visual Question Answering'.",
     license="MIT",
     zip_safe=True,
 )