lgcosta/paperless-ngx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Adds documentation of the new arguments

Browse Source
This commit is contained in:
Trenton H 2023-11-09 08:15:21 -08:00
parent d231dc199d
commit 9af8d4f186
2 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/administration.md
View File

@ -414,6 +414,9 @@ This command takes no arguments.
Use this command to re-create document thumbnails. Optionally include the ` --document {id}` option to generate thumbnails for a specific document only. Use this command to re-create document thumbnails. Optionally include the ` --document {id}` option to generate thumbnails for a specific document only.
You may also specify `--processes` to control the number of processes used to generate new thumbnails. The default is to utilize
a quarter of the available processors.
``` ```
document_thumbnails document_thumbnails
``` ```
@ -592,6 +595,6 @@ document_fuzzy_match [--ratio] [--processes N]
``` ```
| Option | Required | Default | Description | | Option | Required | Default | Description |
| ----------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | | ----------- | -------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| --ratio | No | 85.0 | a number between 0 and 100, setting how similar a document must be for it to be reported. Higher numbers mean more similarity. | | --ratio | No | 85.0 | a number between 0 and 100, setting how similar a document must be for it to be reported. Higher numbers mean more similarity. |
| --processes | No | 4 | Number of processes to use for matching. Setting 1 disables multiple processes | | --processes | No | 1/4 of system cores | Number of processes to use for matching. Setting 1 disables multiple processes |

5
src/documents/management/commands/mixins.py
View File

@ -1,4 +1,5 @@
import os import os
from argparse import ArgumentParser
from django.core.management import CommandError from django.core.management import CommandError
@ -9,7 +10,7 @@ class MultiProcessMixin:
for the use of multiple processes for the use of multiple processes
""" """
def add_argument_processes_mixin(self, parser): def add_argument_processes_mixin(self, parser: ArgumentParser):
parser.add_argument( parser.add_argument(
"--processes", "--processes",
default=max(1, os.cpu_count() // 4), default=max(1, os.cpu_count() // 4),
@ -29,7 +30,7 @@ class ProgressBarMixin:
via this class via this class
""" """
def add_argument_progress_bar_mixin(self, parser): def add_argument_progress_bar_mixin(self, parser: ArgumentParser):
parser.add_argument( parser.add_argument(
"--no-progress-bar", "--no-progress-bar",
default=False, default=False,