From 0246d314d1f2c0d827cff6639ec26304cb8ea246 Mon Sep 17 00:00:00 2001
From: nnnyt <793313994@qq.com>
Date: Tue, 9 Mar 2021 14:34:25 +0800
Subject: [PATCH] update README

---
 README.md | 38 +++++++++++++++++++++++++++++++++++++-
 setup.py  |  1 +
 2 files changed, 38 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index bf99e42..3590f60 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,38 @@
 # CAT
-Computerized Adaptive Testing
\ No newline at end of file
+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
index bae88dc..a887856 100644
--- a/setup.py
+++ b/setup.py
@@ -12,6 +12,7 @@
         'vegas',
         'numpy',
         'scikit-learn',
+        'scipy',
     ],  # And any other dependencies foo needs
     entry_points={
     },