]> git.ipfire.org Git - thirdparty/paperless-ngx.git/commitdiff
Documents the configuration for NLTK related settings
authorTrenton Holmes <797416+stumpylog@users.noreply.github.com>
Sat, 3 Dec 2022 03:21:19 +0000 (19:21 -0800)
committerTrenton H <797416+stumpylog@users.noreply.github.com>
Wed, 7 Dec 2022 17:36:32 +0000 (09:36 -0800)
docs/configuration.md

index bcde72e5fb7750981c18188eee3a5829be53f0f1..d52663f5f8b559985756d0ecba14626e68b3a18d 100644 (file)
@@ -170,6 +170,15 @@ details.
 
     Defaults to "`PAPERLESS_DATA_DIR`/log/".
 
+`PAPERLESS_NLTK_DIR=<path>`
+
+: This is where paperless will search for the data required for NLTK
+processing, if you are using it. If you are using the Docker image,
+this should not be changed, as the data is included in the image
+already.
+
+Defaults to `/usr/local/share/nltk_data`
+
 ## Logging
 
 `PAPERLESS_LOGROTATE_MAX_SIZE=<num>`
@@ -698,6 +707,16 @@ for details on how to set it.
 
     Defaults to UTC.
 
+`PAPERLESS_ENABLE_NLTK=<bool>`
+
+: Enables or disables the advanced natural language processing
+used during automatic classification. If disabled, paperless will
+still preform some basic text pre-processing before matching.
+
+See also `PAPERLESS_NLTK_DIR`.
+
+    Defaults to 1.
+
 ## Polling {#polling}
 
 `PAPERLESS_CONSUMER_POLLING=<num>`