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.

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

docs: small docs issues #19

Merged
merged 1 commit into from
Apr 22, 2024
Merged

Conversation

ds-sebastianchwilczynski
Copy link
Contributor

When I was writing integration with Chromadb docs didn't want to build. This PR fixes these small issues.

Copy link

Trivy scanning results.

Copy link
Member

@mhordynski mhordynski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@ds-sebastianchwilczynski ds-sebastianchwilczynski changed the title fix: small docs issues docs: small docs issues Apr 22, 2024
Copy link

badge

Code Coverage Summary

Filename                                                         Stmts    Miss  Cover    Missing
-------------------------------------------------------------  -------  ------  -------  -----------------------------------------------
dbally/_main.py                                                     12       0  100.00%
dbally/collection.py                                                89       1  98.88%   215
dbally/assistants/base.py                                           23       0  100.00%
dbally/assistants/openai.py                                         59       2  96.61%   59-76
dbally/audit/event_span.py                                           8       2  75.00%   12, 22
dbally/audit/event_tracker.py                                       34      11  67.65%   35, 48, 59, 69, 83-92
dbally/audit/event_handlers/base.py                                 15       0  100.00%
dbally/audit/event_handlers/cli_event_handler.py                    42      27  35.71%   5-8, 38-39, 42-46, 56-58, 70-78, 90-93, 104-107
dbally/audit/event_handlers/langsmith_event_handler.py              25      21  16.00%   6-92
dbally/data_models/audit.py                                         22       0  100.00%
dbally/data_models/execution_result.py                              14       0  100.00%
dbally/data_models/llm_options.py                                   13       0  100.00%
dbally/data_models/prompts/common_validation_utils.py               15       0  100.00%
dbally/data_models/prompts/iql_prompt_template.py                   13       1  92.31%   39
dbally/data_models/prompts/nl_responder_prompt_template.py           8       0  100.00%
dbally/data_models/prompts/prompt_template.py                       28       2  92.86%   27, 35
dbally/data_models/prompts/query_explainer_prompt_template.py        8       0  100.00%
dbally/data_models/prompts/view_selector_prompt_template.py         12       2  83.33%   33-34
dbally/embedding_client/base.py                                      5       5  0.00%    2-10
dbally/embedding_client/openai.py                                   19      19  0.00%    1-52
dbally/iql/_exceptions.py                                           24       1  95.83%   33
dbally/iql/_processor.py                                            78       7  91.03%   15, 43, 60, 66, 72, 81, 87
dbally/iql/_query.py                                                12       1  91.67%   7
dbally/iql/_type_validators.py                                      39       2  94.87%   24, 28
dbally/iql/syntax.py                                                36       9  75.00%   6-9, 27, 36, 60, 63-66
dbally/iql_generator/iql_generator.py                               32       0  100.00%
dbally/llm_client/base.py                                           20       9  55.00%   24-25, 50-69
dbally/llm_client/openai_client.py                                  21      21  0.00%    1-62
dbally/nl_responder/nl_responder.py                                 31       5  83.87%   75, 82-90
dbally/nl_responder/token_counters.py                               23      10  56.52%   24-25, 53-63
dbally/prompts/prompt_builder.py                                    20       3  85.00%   6, 26-27
dbally/similarity/detector.py                                       73       6  91.78%   21, 200-204
dbally/similarity/faiss_store.py                                    36      33  8.33%    5-94
dbally/similarity/fetcher.py                                         5       0  100.00%
dbally/similarity/index.py                                          18       6  66.67%   47-48, 54-55, 67-68
dbally/similarity/sqlalchemy_base.py                                40      21  47.50%   17, 35-37, 48-50, 59, 68-71, 81-87, 105-108
dbally/similarity/store.py                                           7       0  100.00%
dbally/utils/errors.py                                               2       0  100.00%
dbally/view_selection/base.py                                        6       0  100.00%
dbally/view_selection/llm_view_selector.py                          20       0  100.00%
dbally/view_selection/random_view_selector.py                        9       9  0.00%    1-27
dbally/views/base.py                                                 7       0  100.00%
dbally/views/decorators.py                                           6       0  100.00%
dbally/views/exposed_functions.py                                   33       1  96.97%   24
dbally/views/methods_base.py                                        34       2  94.12%   75, 83
dbally/views/pandas_base.py                                         33       1  96.97%   64
dbally/views/sqlalchemy_base.py                                     37       7  81.08%   48, 63-65, 83-87
dbally/views/structured.py                                          34       1  97.06%   30
dbally_cli/main.py                                                   5       5  0.00%    1-11
dbally_cli/similarity.py                                            21       0  100.00%
TOTAL                                                             1226     253  79.36%

Diff against main

Filename      Stmts    Miss  Cover
----------  -------  ------  --------
TOTAL             0       0  +100.00%

Results for commit: 094b009

Minimum allowed coverage is 60%

♻️ This comment has been updated with latest results

@ds-sebastianchwilczynski ds-sebastianchwilczynski merged commit 4a26cbb into main Apr 22, 2024
3 checks passed
@ds-sebastianchwilczynski ds-sebastianchwilczynski deleted the sc/small_docs_issues branch April 22, 2024 09:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants