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

Added: description for TextualFileSplittingModel and MultimodalFileSplittingModel #469

Merged
merged 7 commits into from
Mar 14, 2024

Conversation

MohamedAmineDHIAB
Copy link
Collaborator

@MohamedAmineDHIAB MohamedAmineDHIAB commented Mar 4, 2024

  • Added: missing description for TextualFileSplittingModel and MultimodalFileSplittingModel classes
  • Updated: description for ContextAwareFileSplittingModel

Copy link

github-actions bot commented Mar 4, 2024

Name                                               Stmts   Miss  Cover
----------------------------------------------------------------------
konfuzio_sdk/__init__.py                               8      1    88%
konfuzio_sdk/api.py                                  367     70    81%
konfuzio_sdk/cli.py                                   30      1    97%
konfuzio_sdk/data.py                                2203    228    90%
konfuzio_sdk/evaluate.py                             366     29    92%
konfuzio_sdk/extras.py                                73     17    77%
konfuzio_sdk/normalize.py                            380     27    93%
konfuzio_sdk/regex.py                                107      0   100%
konfuzio_sdk/samples.py                              149      0   100%
konfuzio_sdk/settings_importer.py                     35      1    97%
konfuzio_sdk/tokenizer/__init__.py                     0      0   100%
konfuzio_sdk/tokenizer/base.py                       173     28    84%
konfuzio_sdk/tokenizer/paragraph_and_sentence.py     174     10    94%
konfuzio_sdk/tokenizer/regex.py                       96      2    98%
konfuzio_sdk/trainer/__init__.py                       0      0   100%
konfuzio_sdk/trainer/base.py                         161     23    86%
konfuzio_sdk/trainer/document_categorization.py      784     74    91%
konfuzio_sdk/trainer/file_splitting.py               520     38    93%
konfuzio_sdk/trainer/image.py                         46     17    63%
konfuzio_sdk/trainer/information_extraction.py      1064     86    92%
konfuzio_sdk/trainer/tokenization.py                 136     97    29%
konfuzio_sdk/trainer/utils.py                         47      0   100%
konfuzio_sdk/urls.py                                 107     12    89%
konfuzio_sdk/utils.py                                409    124    70%
----------------------------------------------------------------------
TOTAL                                               7435    885    88%

docs/sdk/home/index.md Outdated Show resolved Hide resolved
docs/sdk/home/index.md Outdated Show resolved Hide resolved
@iftwigs
Copy link
Collaborator

iftwigs commented Mar 7, 2024

Also please add a description.

iftwigs
iftwigs previously approved these changes Mar 7, 2024
Copy link

Name                                               Stmts   Miss  Cover
----------------------------------------------------------------------
konfuzio_sdk/__init__.py                               8      1    88%
konfuzio_sdk/api.py                                  368     71    81%
konfuzio_sdk/cli.py                                   30      1    97%
konfuzio_sdk/data.py                                2203    228    90%
konfuzio_sdk/evaluate.py                             366     29    92%
konfuzio_sdk/extras.py                                73     17    77%
konfuzio_sdk/normalize.py                            380     27    93%
konfuzio_sdk/regex.py                                107      0   100%
konfuzio_sdk/samples.py                              149      0   100%
konfuzio_sdk/settings_importer.py                     35      1    97%
konfuzio_sdk/tokenizer/__init__.py                     0      0   100%
konfuzio_sdk/tokenizer/base.py                       173     28    84%
konfuzio_sdk/tokenizer/paragraph_and_sentence.py     174     10    94%
konfuzio_sdk/tokenizer/regex.py                       96      2    98%
konfuzio_sdk/trainer/__init__.py                       0      0   100%
konfuzio_sdk/trainer/base.py                         161     23    86%
konfuzio_sdk/trainer/document_categorization.py      784     74    91%
konfuzio_sdk/trainer/file_splitting.py               520     38    93%
konfuzio_sdk/trainer/image.py                         46     17    63%
konfuzio_sdk/trainer/information_extraction.py      1064     86    92%
konfuzio_sdk/trainer/tokenization.py                 136     97    29%
konfuzio_sdk/trainer/utils.py                         47      0   100%
konfuzio_sdk/urls.py                                 107     12    89%
konfuzio_sdk/utils.py                                409    124    70%
----------------------------------------------------------------------
TOTAL                                               7436    886    88%

Copy link

Name                                               Stmts   Miss  Cover
----------------------------------------------------------------------
konfuzio_sdk/__init__.py                               8      1    88%
konfuzio_sdk/api.py                                  368     71    81%
konfuzio_sdk/cli.py                                   30      1    97%
konfuzio_sdk/data.py                                2203    228    90%
konfuzio_sdk/evaluate.py                             366     29    92%
konfuzio_sdk/extras.py                                73     17    77%
konfuzio_sdk/normalize.py                            380     27    93%
konfuzio_sdk/regex.py                                107      0   100%
konfuzio_sdk/samples.py                              149      0   100%
konfuzio_sdk/settings_importer.py                     35      1    97%
konfuzio_sdk/tokenizer/__init__.py                     0      0   100%
konfuzio_sdk/tokenizer/base.py                       173     28    84%
konfuzio_sdk/tokenizer/paragraph_and_sentence.py     174     10    94%
konfuzio_sdk/tokenizer/regex.py                       96      2    98%
konfuzio_sdk/trainer/__init__.py                       0      0   100%
konfuzio_sdk/trainer/base.py                         161     23    86%
konfuzio_sdk/trainer/document_categorization.py      784     74    91%
konfuzio_sdk/trainer/file_splitting.py               520     38    93%
konfuzio_sdk/trainer/image.py                         46     17    63%
konfuzio_sdk/trainer/information_extraction.py      1064     86    92%
konfuzio_sdk/trainer/tokenization.py                 136     97    29%
konfuzio_sdk/trainer/utils.py                         47      0   100%
konfuzio_sdk/urls.py                                 107     12    89%
konfuzio_sdk/utils.py                                409    124    70%
----------------------------------------------------------------------
TOTAL                                               7436    886    88%

Copy link

Name                                               Stmts   Miss  Cover
----------------------------------------------------------------------
konfuzio_sdk/__init__.py                               8      1    88%
konfuzio_sdk/api.py                                  368     71    81%
konfuzio_sdk/cli.py                                   30      1    97%
konfuzio_sdk/data.py                                2203    228    90%
konfuzio_sdk/evaluate.py                             366     29    92%
konfuzio_sdk/extras.py                                73     17    77%
konfuzio_sdk/normalize.py                            380     27    93%
konfuzio_sdk/regex.py                                107      0   100%
konfuzio_sdk/samples.py                              149      0   100%
konfuzio_sdk/settings_importer.py                     35      1    97%
konfuzio_sdk/tokenizer/__init__.py                     0      0   100%
konfuzio_sdk/tokenizer/base.py                       173     28    84%
konfuzio_sdk/tokenizer/paragraph_and_sentence.py     174     10    94%
konfuzio_sdk/tokenizer/regex.py                       96      2    98%
konfuzio_sdk/trainer/__init__.py                       0      0   100%
konfuzio_sdk/trainer/base.py                         161     23    86%
konfuzio_sdk/trainer/document_categorization.py      784     74    91%
konfuzio_sdk/trainer/file_splitting.py               520     38    93%
konfuzio_sdk/trainer/image.py                         46     17    63%
konfuzio_sdk/trainer/information_extraction.py      1064     86    92%
konfuzio_sdk/trainer/tokenization.py                 136     97    29%
konfuzio_sdk/trainer/utils.py                         47      0   100%
konfuzio_sdk/urls.py                                 107     12    89%
konfuzio_sdk/utils.py                                409    124    70%
----------------------------------------------------------------------
TOTAL                                               7436    886    88%

Copy link

Name                                               Stmts   Miss  Cover
----------------------------------------------------------------------
konfuzio_sdk/__init__.py                               8      1    88%
konfuzio_sdk/api.py                                  368     71    81%
konfuzio_sdk/cli.py                                   30      1    97%
konfuzio_sdk/data.py                                2203    228    90%
konfuzio_sdk/evaluate.py                             366     29    92%
konfuzio_sdk/extras.py                                73     17    77%
konfuzio_sdk/normalize.py                            380     27    93%
konfuzio_sdk/regex.py                                107      0   100%
konfuzio_sdk/samples.py                              149      0   100%
konfuzio_sdk/settings_importer.py                     35      1    97%
konfuzio_sdk/tokenizer/__init__.py                     0      0   100%
konfuzio_sdk/tokenizer/base.py                       173     28    84%
konfuzio_sdk/tokenizer/paragraph_and_sentence.py     174     10    94%
konfuzio_sdk/tokenizer/regex.py                       96      2    98%
konfuzio_sdk/trainer/__init__.py                       0      0   100%
konfuzio_sdk/trainer/base.py                         161     23    86%
konfuzio_sdk/trainer/document_categorization.py      784     74    91%
konfuzio_sdk/trainer/file_splitting.py               520     38    93%
konfuzio_sdk/trainer/image.py                         46     17    63%
konfuzio_sdk/trainer/information_extraction.py      1064     86    92%
konfuzio_sdk/trainer/tokenization.py                 136     97    29%
konfuzio_sdk/trainer/utils.py                         47      0   100%
konfuzio_sdk/urls.py                                 107     12    89%
konfuzio_sdk/utils.py                                409    124    70%
----------------------------------------------------------------------
TOTAL                                               7436    886    88%

@zypriafl zypriafl merged commit 4b158e3 into master Mar 14, 2024
5 of 11 checks passed
@zypriafl zypriafl deleted the 12319-adding-textualfilesplitting-documentation branch March 14, 2024 20:16
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.

3 participants