Release v0.0.3 (#1)

Author: yarnabrina

.flake8

@@ -1,5 +1,8 @@
 [flake8]
-extend-ignore = E203
+extend-ignore =
+    # whitespace before ‘,’, ‘;’, or ‘:’
+    E203
 per-file-ignores =
+    # module imported but unused
     __init__.py: F401
 max-line-length = 99

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v4.6.0
     hooks:
       - id: check-ast
       - id: check-case-conflict
@@ -16,6 +16,9 @@ repos:
       - id: detect-private-key
       - id: end-of-file-fixer
       - id: mixed-line-ending
+      - id: name-tests-test
+        args:
+          - --pytest-test-first
       - id: no-commit-to-branch
       - id: pretty-format-json
         args:
@@ -25,37 +28,45 @@ repos:
       - id: requirements-txt-fixer
       - id: trailing-whitespace
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.15.0
+    rev: v3.15.2
     hooks:
       - id: pyupgrade
         args:
           - --keep-runtime-typing
           - --py311-plus
+        stages:
+          - manual
   - repo: https://github.com/pycqa/autoflake
-    rev: v2.2.1
+    rev: v2.3.1
     hooks:
       - id: autoflake
         args:
           - src
         pass_filenames: false
+        stages:
+          - manual
   - repo: https://github.com/pycqa/isort
     rev: 5.13.2
     hooks:
       - id: isort
         args:
           - src
         pass_filenames: false
+        stages:
+          - manual
   - repo: https://github.com/psf/black
-    rev: 24.1.0
+    rev: 24.3.0
     hooks:
       - id: black
         additional_dependencies:
           - .[jupyter]
         args:
           - src
         pass_filenames: false
+        stages:
+          - manual
   - repo: https://github.com/pycqa/bandit
-    rev: 1.7.7
+    rev: 1.7.8
     hooks:
       - id: bandit
         args:
@@ -73,8 +84,10 @@ repos:
         args:
           - src
         pass_filenames: false
+        stages:
+          - manual
   - repo: https://github.com/PyCQA/pylint
-    rev: v3.0.3
+    rev: v3.1.0
     hooks:
       - id: pylint
         args:
@@ -85,14 +98,18 @@ repos:
         stages:
           - manual
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.1.14
+    rev: v0.3.5
     hooks:
       - id: ruff
         args:
           - src
         pass_filenames: false
+      - id: ruff-format
+        args:
+          - src
+        pass_filenames: false
   - repo: https://github.com/jendrikseipp/vulture
-    rev: v2.10
+    rev: v2.11
     hooks:
       - id: vulture
         pass_filenames: false
@@ -116,12 +133,18 @@ repos:
           - --target-version
           - py311
   - repo: https://github.com/econchick/interrogate
-    rev: 1.5.0
+    rev: 1.6.0
     hooks:
       - id: interrogate
         args:
           - src
         pass_filenames: false
+  - repo: https://github.com/numpy/numpydoc
+    rev: v1.7.0
+    hooks:
+      - id: numpydoc-validation
+        stages:
+          - manual
   - repo: https://github.com/tox-dev/pyproject-fmt
     rev: 1.7.0
     hooks:
@@ -140,6 +163,19 @@ repos:
           - --write-changes
         stages:
           - manual
+  - repo: https://github.com/crate-ci/typos
+    rev: v1.20.4
+    hooks:
+      - id: typos
+        args:
+          - --force-exclude
+          - --write-changes
+          - --locale
+          - en-gb
+          - --format
+          - brief
+        stages:
+          - manual
 default_language_version:
   python: python3.11
 fail_fast: false

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Anirban Ray
+Copyright (c) 2023-2024 Anirban Ray
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

docs/source/conf.py

@@ -8,7 +8,7 @@
 
 project = "query-package-documentation"
 version = str(generative_ai.__version__)
-project_copyright = "2024, Anirban Ray"
+project_copyright = "2023-2024, Anirban Ray"
 author = "Anirban Ray"
 release = f"v{version}"
 

docs/source/guidelines/CLI.md

@@ -35,10 +35,10 @@ Database generation complete: '/full/path/to/working/directory/vector_database'.
 $ docs-cli answer-query "How many modules are there in information retrieval sub-package?" --embedding-model "all-mpnet-base-v2" --database-directory "vector_database" --search-type "similarity" --number-of-documents 5 --language-model-type "standard_transformers" --standard-pipeline-type "text2text-generation" --standard-model-name "google/flan-t5-large"
 Query: How many modules are there in information retrieval sub-package?
 Answer: 5
-Duration: 2.28 seconds
+Duration: 1.69 seconds
 Source 1: 'information_retrieval' package has 5 many modules.
 Source 2: Modules of 'information_retrieval' package are as follows: 1. orchestrate_retrieval 2. step_1_retrieval 3. step_2_retrieval 4. step_3_retrieval 5. utils_retrieval.
-Source 3: 'information_retrieval' package has 23 many public exports.
+Source 3: 'information_retrieval' package has 22 many public exports.
 Source 4: Hierarchy of 'information_retrieval' package is as follows: 1. generative_ai 2. information_retrieval.
 Source 5: Hierarchy of 'utils_retrieval' module is as follows: 1. generative_ai 2. information_retrieval 3. utils_retrieval.
 ```
@@ -50,7 +50,7 @@ $ docs-cli answer-query "What are different types of retrieval supported by this
 Query: What are different types of retrieval supported by this package?
 Answer: MMR and Similarity.
 
-Duration: 20.75 seconds
+Duration: 22.97 seconds
 Source 1: The following is the documentation of 'RetrievalType' object: 'Define supported retrieval types.'.
 Source 2: 'information_retrieval' package has 5 many modules.
 Source 3: Names of different members of 'RetrievalType' enum are as follows: 1. MMR 2. SIMILARITY.
@@ -64,7 +64,7 @@ Source 5: The following is the documentation of 'information_retrieval' package:
 $ docs-cli answer-query "List public exports of dataset generation package." --embedding-model "all-mpnet-base-v2" --database-directory "vector_database" --search-type "mmr" --number-of-documents 5 --initial-number-of-documents 10 --language-model-type "quantised_ctransformers" --quantised-model-name "TheBloke/Mistral-7B-v0.1-GGUF" --quantised-model-file "mistral-7b-v0.1.Q4_K_M.gguf" --quantised-model-type "mistral"
 Query: List public exports of dataset generation package.
 Answer: The following is the list of public exports of 'dataset_generation' package: 1. JSONDataset 2. JSONDocument 3. generate_json_dataset 4. generate_member_dataset 5. generate_module_dataset 6. generate_package_dataset 7. generate_raw_datasets 8. get_all_member_details 9. get_all_module_contents 10. get_all_package_contents 11. load_json_dataset 12. store_json_dataset.
-Duration: 58.37 seconds
+Duration: 57.91 seconds
 Source 1: 'dataset_generation' package has 12 many public exports.
 Source 2: Documentation of 'generate_package_dataset' function lacks any examples.
 Source 3: The following is the documentation of 'generate_raw_datasets' object: 'Generate all retrieval and tuning documents for exploring documentation of a package.