update README

PranavUikey · Mar 9, 2021 · 0246d31 · 0246d31
1 parent 52117ef
commit 0246d31
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,2 +1,38 @@
 # CAT
-Computerized Adaptive Testing
+Computerized Adaptive Testing Package, including the following models and strategies.
+
+* Item Response Theory (IRT)
+  * MaximumFisherInformation (MFI) strategy
+  * Kullback-Leibler Information (KLI) strategy
+  * Model-Agnostic Adaptive Testing (MAAT) strategy
+* Multidimensional Item Response Theory (MIRT)
+  * D-Optimality (D-opt) strategy
+  * Multivariate Kullback-Leibler Information (MKLI) strategy
+  * Model-Agnostic Adaptive Testing (MAAT) strategy
+* Neural Cognitive Diagnosis (NCD)
+  * Model-Agnostic Adaptive Testing (MAAT) strategy
+
+## Installation
+
+Git and install by `pip`
+
+```
+pip install -e .
+```
+
+## Quick Start
+
+See the examples in `scripts` directory.
+
+## utils
+
+### Visualization
+
+By default, we use `tensorboard` to help visualize the reward of each iteration, see demos in `scripts` and use
+
+```
+tensorboard --logdir /path/to/logs
+```
+
+to see the visualization result.
+
diff --git a/setup.py b/setup.py
@@ -12,6 +12,7 @@
         'vegas',
         'numpy',
         'scikit-learn',
+        'scipy',
     ],  # And any other dependencies foo needs
     entry_points={
     },