Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(document-search): init document-search module with basic RAG capabilities on text #3

Merged
merged 2 commits into from
Sep 16, 2024
Merged

feat(document-search): init document-search module with basic RAG capabilities on text #3

merged 2 commits into from
Sep 16, 2024

Conversation

mhordynski
Copy link
Member

@mhordynski mhordynski commented Sep 11, 2024 •
edited
Loading

This PR:

  • adds basic structure for document-search module, with a basic types and interfaces defined
  • adds simple in memory vector storage
  • adds mocked functionality to ingest text based documents into a system

@mhordynski mhordynski force-pushed the feature/document-search branch from e1090a1 to 71f7cf7 Compare September 11, 2024 15:50
@github-actions GitHub Actions
Copy link
Contributor

Trivy scanning results.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Sep 11, 2024 •
edited
Loading

🧪 Test coverage: 94.19%

Code Coverage Summary

Filename                                                                                                  Stmts    Miss  Cover    Missing
------------------------------------------------------------------------------------------------------  -------  ------  -------  -----------------------
packages/ragnarok-common/src/ragnarok_common/__init__.py                                                      0       0  100.00%
packages/ragnarok-common/src/ragnarok_common/embeddings/__init__.py                                           0       0  100.00%
packages/ragnarok-common/src/ragnarok_common/embeddings/base.py                                               4       0  100.00%
packages/ragnarok-common/src/ragnarok_common/llms/__init__.py                                                 4       0  100.00%
packages/ragnarok-common/src/ragnarok_common/llms/base.py                                                    33       4  87.88%   33, 52, 88, 97
packages/ragnarok-common/src/ragnarok_common/llms/litellm.py                                                 25       4  84.00%   8-9, 54, 85
packages/ragnarok-common/src/ragnarok_common/llms/local.py                                                   24       9  62.50%   7, 39-44, 54, 67-68
packages/ragnarok-common/src/ragnarok_common/llms/types.py                                                    8       2  75.00%   24, 28
packages/ragnarok-common/src/ragnarok_common/llms/clients/__init__.py                                         4       0  100.00%
packages/ragnarok-common/src/ragnarok_common/llms/clients/base.py                                            23       0  100.00%
packages/ragnarok-common/src/ragnarok_common/llms/clients/exceptions.py                                      14       6  57.14%   7-8, 17, 26-27, 36
packages/ragnarok-common/src/ragnarok_common/llms/clients/litellm.py                                         50      10  80.00%   10-11, 70, 108, 122-127
packages/ragnarok-common/src/ragnarok_common/llms/clients/local.py                                           37      12  67.57%   8-10, 59-67, 89-100
packages/ragnarok-common/src/ragnarok_common/prompt/__init__.py                                               2       0  100.00%
packages/ragnarok-common/src/ragnarok_common/prompt/base.py                                                  18       0  100.00%
packages/ragnarok-common/src/ragnarok_common/prompt/parsers.py                                               34       0  100.00%
packages/ragnarok-common/src/ragnarok_common/prompt/prompt.py                                                96       2  97.92%   103, 107
packages/ragnarok-common/tests/__init__.py                                                                    0       0  100.00%
packages/ragnarok-common/tests/unit/__init__.py                                                               0       0  100.00%
packages/ragnarok-common/tests/unit/llms/__init__.py                                                          0       0  100.00%
packages/ragnarok-common/tests/unit/llms/test_litellm.py                                                     63       0  100.00%
packages/ragnarok-common/tests/unit/prompts/__init__.py                                                       0       0  100.00%
packages/ragnarok-common/tests/unit/prompts/test_parsers.py                                                  65       0  100.00%
packages/ragnarok-common/tests/unit/prompts/test_prompt.py                                                   81       0  100.00%
packages/ragnarok-dev-kit/src/ragnarok_dev_kit/__init__.py                                                    0       0  100.00%
packages/ragnarok-dev-kit/src/ragnarok_dev_kit/discovery/__init__.py                                          2       0  100.00%
packages/ragnarok-dev-kit/src/ragnarok_dev_kit/discovery/prompt_discovery.py                                 38       1  97.37%   62
packages/ragnarok-dev-kit/tests/unit/discovery/prompt_classes_for_tests.py                                   27       0  100.00%
packages/ragnarok-dev-kit/tests/unit/discovery/test_prompt_discovery.py                                      25       0  100.00%
packages/ragnarok-dev-kit/tests/unit/discovery/ragnarok_tests_pkg_with_prompts/__init__.py                    2       0  100.00%
packages/ragnarok-dev-kit/tests/unit/discovery/ragnarok_tests_pkg_with_prompts/prompts/__init__.py            3       0  100.00%
packages/ragnarok-dev-kit/tests/unit/discovery/ragnarok_tests_pkg_with_prompts/prompts/temp_prompt1.py       14       0  100.00%
packages/ragnarok-dev-kit/tests/unit/discovery/ragnarok_tests_pkg_with_prompts/prompts/temp_prompt2.py       14       0  100.00%
packages/ragnarok-document-search/src/ragnarok_document_search/__init__.py                                    2       0  100.00%
packages/ragnarok-document-search/src/ragnarok_document_search/_main.py                                      33       0  100.00%
packages/ragnarok-document-search/src/ragnarok_document_search/documents/__init__.py                          0       0  100.00%
packages/ragnarok-document-search/src/ragnarok_document_search/documents/document.py                         35       2  94.29%   33, 89
packages/ragnarok-document-search/src/ragnarok_document_search/documents/element.py                          30       1  96.67%   33
packages/ragnarok-document-search/src/ragnarok_document_search/documents/sources.py                          16       1  93.75%   47
packages/ragnarok-document-search/src/ragnarok_document_search/ingestion/__init__.py                          0       0  100.00%
packages/ragnarok-document-search/src/ragnarok_document_search/ingestion/document_processor.py                9       1  88.89%   35
packages/ragnarok-document-search/src/ragnarok_document_search/retrieval/__init__.py                          0       0  100.00%
packages/ragnarok-document-search/src/ragnarok_document_search/retrieval/rephrasers/__init__.py               0       0  100.00%
packages/ragnarok-document-search/src/ragnarok_document_search/retrieval/rephrasers/base.py                   5       0  100.00%
packages/ragnarok-document-search/src/ragnarok_document_search/retrieval/rephrasers/noop.py                   5       0  100.00%
packages/ragnarok-document-search/src/ragnarok_document_search/retrieval/rerankers/__init__.py                0       0  100.00%
packages/ragnarok-document-search/src/ragnarok_document_search/retrieval/rerankers/base.py                    6       0  100.00%
packages/ragnarok-document-search/src/ragnarok_document_search/retrieval/rerankers/noop.py                    7       0  100.00%
packages/ragnarok-document-search/src/ragnarok_document_search/vector_store/__init__.py                       0       0  100.00%
packages/ragnarok-document-search/src/ragnarok_document_search/vector_store/base.py                          12       0  100.00%
packages/ragnarok-document-search/src/ragnarok_document_search/vector_store/in_memory.py                     18       0  100.00%
packages/ragnarok-document-search/tests/unit/__init__.py                                                      0       0  100.00%
packages/ragnarok-document-search/tests/unit/test_document_search.py                                         14       0  100.00%
packages/ragnarok-document-search/tests/unit/test_documents.py                                               13       0  100.00%
packages/ragnarok-document-search/tests/unit/test_elements.py                                                15       0  100.00%
packages/ragnarok-document-search/tests/unit/test_simple_vector_store.py                                     16       0  100.00%
TOTAL                                                                                                       946      55  94.19%

Diff against main

Filename                                                                                           Stmts    Miss  Cover
-----------------------------------------------------------------------------------------------  -------  ------  --------
packages/ragnarok-common/src/ragnarok_common/embeddings/__init__.py                                    0       0  +100.00%
packages/ragnarok-common/src/ragnarok_common/embeddings/base.py                                       +4       0  +100.00%
packages/ragnarok-document-search/src/ragnarok_document_search/__init__.py                            +2       0  +100.00%
packages/ragnarok-document-search/src/ragnarok_document_search/_main.py                              +33       0  +100.00%
packages/ragnarok-document-search/src/ragnarok_document_search/documents/__init__.py                   0       0  +100.00%
packages/ragnarok-document-search/src/ragnarok_document_search/documents/document.py                 +35      +2  +94.29%
packages/ragnarok-document-search/src/ragnarok_document_search/documents/element.py                  +30      +1  +96.67%
packages/ragnarok-document-search/src/ragnarok_document_search/documents/sources.py                  +16      +1  +93.75%
packages/ragnarok-document-search/src/ragnarok_document_search/ingestion/__init__.py                   0       0  +100.00%
packages/ragnarok-document-search/src/ragnarok_document_search/ingestion/document_processor.py        +9      +1  +88.89%
packages/ragnarok-document-search/src/ragnarok_document_search/retrieval/__init__.py                   0       0  +100.00%
packages/ragnarok-document-search/src/ragnarok_document_search/retrieval/rephrasers/__init__.py        0       0  +100.00%
packages/ragnarok-document-search/src/ragnarok_document_search/retrieval/rephrasers/base.py           +5       0  +100.00%
packages/ragnarok-document-search/src/ragnarok_document_search/retrieval/rephrasers/noop.py           +5       0  +100.00%
packages/ragnarok-document-search/src/ragnarok_document_search/retrieval/rerankers/__init__.py         0       0  +100.00%
packages/ragnarok-document-search/src/ragnarok_document_search/retrieval/rerankers/base.py            +6       0  +100.00%
packages/ragnarok-document-search/src/ragnarok_document_search/retrieval/rerankers/noop.py            +7       0  +100.00%
packages/ragnarok-document-search/src/ragnarok_document_search/vector_store/__init__.py                0       0  +100.00%
packages/ragnarok-document-search/src/ragnarok_document_search/vector_store/base.py                  +12       0  +100.00%
packages/ragnarok-document-search/src/ragnarok_document_search/vector_store/in_memory.py             +18       0  +100.00%
packages/ragnarok-document-search/tests/unit/__init__.py                                               0       0  +100.00%
packages/ragnarok-document-search/tests/unit/test_document_search.py                                 +14       0  +100.00%
packages/ragnarok-document-search/tests/unit/test_documents.py                                       +13       0  +100.00%
packages/ragnarok-document-search/tests/unit/test_elements.py                                        +15       0  +100.00%
packages/ragnarok-document-search/tests/unit/test_simple_vector_store.py                             +16       0  +100.00%
TOTAL                                                                                               +240      +5  +1.27%

Results for commit: 4212065

Minimum allowed coverage is 60%

♻️ This comment has been updated with latest results

@micpst micpst added feature New feature or request document search Changes to the document search package labels Sep 12, 2024
@mhordynski mhordynski merged commit c8ae2f9 into main Sep 16, 2024
3 checks passed
@micpst micpst deleted the feature/document-search branch September 16, 2024 09:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@akonarski-ds akonarski-ds akonarski-ds left review comments

@PatrykWyzgowski PatrykWyzgowski PatrykWyzgowski left review comments

@micpst micpst micpst approved these changes

Assignees
No one assigned
Labels
document search Changes to the document search package feature New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@mhordynski @PatrykWyzgowski @micpst @akonarski-ds