summaryrefslogtreecommitdiffstats
path: root/academic/dimod/README
diff options
context:
space:
mode:
Diffstat (limited to 'academic/dimod/README')
-rw-r--r--academic/dimod/README12
1 files changed, 12 insertions, 0 deletions
diff --git a/academic/dimod/README b/academic/dimod/README
new file mode 100644
index 0000000000..23a53588f8
--- /dev/null
+++ b/academic/dimod/README
@@ -0,0 +1,12 @@
+ dimod is a shared API for samplers. It provides:
+
+ - classes for quadratic models---such as the binary quadratic model
+ (BQM) class that contains Ising and QUBO models used by samplers
+ such as the D-Wave system---and higher-order (non-quadratic)
+ models.
+ - reference examples of samplers and composed samplers.
+ - abstract base classes for constructing new samplers and composed
+ samplers.
+
+
+ If you want to run the tests set the environment variable TESTS=yes.