Skip to main content

Generate similarity scores for documents from cli

Project description

similar-documents

Generates similarity document scores from cli. Useful when combined with static site generators.

$ similar-documents -h
usage: $ similar_documents -o result.json -k 5 -t japanese *.md
       $ similar_documents -h

positional arguments:
  documents             list[str]

optional arguments:
  -h, --help            show this help message and exit
  -o None, --output-file None
                        Optional: write output file (default STDOUT)
  -k 5, --top-k 5       Number of similar documents
  -d, --debug           Show debug messages
  -t None, --tokenizer None
                        tokenizer [japanese] (default None(space splitting))
  -e utf-8, --encoding utf-8
                        file encoding(default utf-8)
$ similar-documents -t japanese -k 2 /data/markdowns/recently/*.md | jq . | head -20
{
  "/data/markdowns/recently/2021-04-01.md": [
    [
      "/data/markdowns/recently/2021-04-26.md",
      0.3123780045484529
    ],
    [
      "/data/markdowns/recently/2021-04-03.md",
      0.17384380113610887
    ]
  ],
  "/data/markdowns/recently/2021-04-02.md": [
    [
      "/data/markdowns/recently/2021-04-26.md",
      0.10715535963136594
    ],
    [
      "/data/markdowns/recently/2021-04-23.md",
      0.09411751563901728
    ]

Installation

pip install -U similar-documents

On Docker

$ docker build -t similar-doc .
# examples: run on windows
$ docker run -it -v C:\Users\yu1\Dropbox\secon-sites\data:/data/ --rm similar-doc bash -c 'similar-documents -t japanese -k 2 -o /data/result.json `ls /data/markdowns/*/*.md`'

Lisence

MIT

Author

  • Yuichi Tateno

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

similar_documents-0.1.4.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

similar_documents-0.1.4-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

Details for the file similar_documents-0.1.4.tar.gz.

File metadata

  • Download URL: similar_documents-0.1.4.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.3.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

File hashes

Hashes for similar_documents-0.1.4.tar.gz
Algorithm Hash digest
SHA256 77df94b3cc8eadf2c2db74614864da6877d5d07fc3f7bca0de92364e3b40fcf9
MD5 bf65c8fa731dea49c618a024bbcfadde
BLAKE2b-256 a6328a7fe7de8f51fac953df0b7dfef5d7aba05d1cc4062a2d1c134d40001dbf

See more details on using hashes here.

File details

Details for the file similar_documents-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: similar_documents-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 8.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.3.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

File hashes

Hashes for similar_documents-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 7498ce1e8adbfb5e10d6ae9e4a8f1f9227b89aa53425136f6fdef63a11788194
MD5 3adcc25c4731a66ff764908cf8dedf77
BLAKE2b-256 e2c8724443b6fe68ff7ded4bba6e2e2e393cc5e69c7a9daac6579197ac67ed26

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page