Fix docs

.readthedocs.yaml

@@ -0,0 +1,22 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.9"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: doc/conf.py
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+    - method: pip
+      path: .
+    - requirements: doc/requirements.txt

README.md

@@ -221,6 +221,6 @@ Contributors:
 * Jinqi (Kathryn) Chen (jinqic@cs.cmu.edu), CMU
 * Zhuolin Yang (zhuolin5@illinois.edu), UIUC
 
-We thank the[commits](https://github.com/KaidiXu/auto_LiRPA/commits) and [pull requests](https://github.com/KaidiXu/auto_LiRPA/pulls) from community contributors.
+We thank the [commits](https://github.com/KaidiXu/auto_LiRPA/commits) and [pull requests](https://github.com/KaidiXu/auto_LiRPA/pulls) from community contributors.
 
 Our library is released under the BSD 3-Clause license.

setup.py

@@ -1,11 +1,12 @@
 from setuptools import setup, find_packages
+from pathlib import Path
 
-"""Check PyTorch version"""
-pytorch_version_l = "1.8.0"
-pytorch_version_u = "1.13.0" # excluded
-msg_install_pytorch = (f"It is recommended to manually install PyTorch "
-                    f"(>={pytorch_version_u},<{pytorch_version_u}) suitable "
-                    "for your system ahead: https://pytorch.org/get-started.\n")
+# Check PyTorch version
+pytorch_version_l = '1.8.0'
+pytorch_version_u = '1.13.0' # excluded
+msg_install_pytorch = (f'It is recommended to manually install PyTorch '
+                    f'(>={pytorch_version_u},<{pytorch_version_u}) suitable '
+                    'for your system ahead: https://pytorch.org/get-started.\n')
 try:
     import torch
     if torch.__version__ < pytorch_version_l:
@@ -22,11 +23,16 @@
         if '__version__' in line:
             version = eval(line.strip().split()[-1])
 
+this_directory = Path(__file__).parent
+long_description = (this_directory / 'README.md').read_text()
+
 print(f'Installing auto_LiRPA {version}')
 setup(
     name='auto_LiRPA',
     version=version,
     description='A library for Automatic Linear Relaxation based Perturbation Analysis (LiRPA) on general computational graphs, with a focus on adversarial robustness verification and certification of deep neural networks.',
+    long_description=long_description,
+    long_description_content_type='text/markdown',
     url='https://github.com/KaidiXu/auto_LiRPA',
     author='Kaidi Xu, Zhouxing Shi, Huan Zhang, Yihan Wang, Shiqi Wang, Linyi Li, Jinqi (Kathryn) Chen, Zhuolin Yang',
     author_email='xu.kaid@husky.neu.edu, zhouxingshichn@gmail.com, huan@huan-zhang.com, wangyihan617@gmail.com, sw3215@columbia.edu,linyi2@illinois.edu,jinqic@cs.cmu.edu,zhuolin5@illinois.edu',
@@ -42,6 +48,7 @@
         'appdirs>=1.4',
         'pyyaml>=5.0',
         'ninja>=1.10',
+        'tqdm>=4.64',
     ],
     platforms=['any'],
     license='BSD',