about summary refs log tree commit diff
path: root/doc/package-notes.xml
diff options
context:
space:
mode:
authorMaximilian Bosch <maximilian@mbosch.me>2019-03-30 19:20:02 +0100
committerGitHub <noreply@github.com>2019-03-30 19:20:02 +0100
commit4cd107f6b3e04cc816cc9c2da1e7a0ca86dbb845 (patch)
treeef9fc1ed6b159f7cbcd5fca79b7f13c4048568e0 /doc/package-notes.xml
parentb556663201f06468226f98ddb28eaeff1f098210 (diff)
parent6fec5aac83e7ad4206050fab82d8e913a8f657bf (diff)
Merge pull request #56786 from Ma27/dlib-avx-fixes
dlib: improve AVX configuration
Diffstat (limited to 'doc/package-notes.xml')
-rw-r--r--doc/package-notes.xml27
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/package-notes.xml b/doc/package-notes.xml
index dfdada3d28c2f..169f70283e6dc 100644
--- a/doc/package-notes.xml
+++ b/doc/package-notes.xml
@@ -887,4 +887,31 @@ citrix_receiver.override {
    </para>
   </section>
  </section>
+ <section xml:id="dlib">
+  <title>DLib</title>
+
+  <para>
+    <link xlink:href="http://dlib.net/">DLib</link> is a modern, C++-based toolkit which
+    provides several machine learning algorithms.
+  </para>
+
+  <section xml:id="compiling-without-avx-support">
+   <title>Compiling without AVX support</title>
+
+   <para>
+     Especially older CPUs don't support
+     <link xlink:href="https://en.wikipedia.org/wiki/Advanced_Vector_Extensions">AVX</link>
+     (<abbrev>Advanced Vector Extensions</abbrev>) instructions that are used by DLib to
+     optimize their algorithms.
+   </para>
+
+   <para>
+    On the affected hardware errors like <literal>Illegal instruction</literal> will occur.
+    In those cases AVX support needs to be disabled:
+<programlisting>self: super: {
+  dlib = super.dlib.override { avxSupport = false; };
+}</programlisting>
+   </para>
+  </section>
+ </section>
 </chapter>