summaryrefslogtreecommitdiffstats
path: root/academic/dimod/slack-desc
diff options
context:
space:
mode:
Diffstat (limited to 'academic/dimod/slack-desc')
-rw-r--r--academic/dimod/slack-desc19
1 files changed, 19 insertions, 0 deletions
diff --git a/academic/dimod/slack-desc b/academic/dimod/slack-desc
new file mode 100644
index 0000000000..fb746b8f61
--- /dev/null
+++ b/academic/dimod/slack-desc
@@ -0,0 +1,19 @@
+# HOW TO EDIT THIS FILE:
+# The "handy ruler" below makes it easier to edit a package description.
+# Line up the first '|' above the ':' following the base package name, and
+# the '|' on the right side marks the last column you can put a character in.
+# You must make exactly 11 lines for the formatting to be correct. It's also
+# customary to leave one space after the ':' except on otherwise blank lines.
+
+ |-----handy-ruler------------------------------------------------------|
+dimod: dimod (A shared API for samplers)
+dimod:
+dimod: dimod is a shared API for samplers. It provides:
+dimod:
+dimod: - classes for quadratic models---such as the binary quadratic
+dimod: model (BQM) class that contains Ising and QUBO models used by
+dimod: samplers such as the D-Wave system---and higher-order
+dimod: (non-quadratic) models.
+dimod: - reference examples of samplers and composed samplers.
+dimod: - abstract base classes for constructing new samplers and composed
+dimod: samplers.