modelbrief 0.2.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (133) hide show
  1. modelbrief-0.2.1/.github/ISSUE_TEMPLATE/bug_report.md +8 -0
  2. modelbrief-0.2.1/.github/ISSUE_TEMPLATE/feature_request.md +6 -0
  3. modelbrief-0.2.1/.github/pull_request_template.md +5 -0
  4. modelbrief-0.2.1/.github/workflows/build.yml +11 -0
  5. modelbrief-0.2.1/.github/workflows/tests.yml +14 -0
  6. modelbrief-0.2.1/.gitignore +12 -0
  7. modelbrief-0.2.1/CONTRIBUTING.md +1091 -0
  8. modelbrief-0.2.1/Frequently Asked Questions.md +260 -0
  9. modelbrief-0.2.1/Getting Started.md +16 -0
  10. modelbrief-0.2.1/LICENSE +9 -0
  11. modelbrief-0.2.1/PKG-INFO +214 -0
  12. modelbrief-0.2.1/README.md +164 -0
  13. modelbrief-0.2.1/docs/ai_features.md +3 -0
  14. modelbrief-0.2.1/docs/classification.md +3 -0
  15. modelbrief-0.2.1/docs/computer_vision.md +3 -0
  16. modelbrief-0.2.1/docs/contributing.md +3 -0
  17. modelbrief-0.2.1/docs/getting_started.md +3 -0
  18. modelbrief-0.2.1/docs/nlp.md +3 -0
  19. modelbrief-0.2.1/docs/regression.md +3 -0
  20. modelbrief-0.2.1/docs/supported_models.md +3 -0
  21. modelbrief-0.2.1/examples/anomaly_detection.py +4 -0
  22. modelbrief-0.2.1/examples/classification.py +5 -0
  23. modelbrief-0.2.1/examples/clustering.py +4 -0
  24. modelbrief-0.2.1/examples/computer_vision/cnn.py +3 -0
  25. modelbrief-0.2.1/examples/computer_vision/image_classification.py +4 -0
  26. modelbrief-0.2.1/examples/computer_vision/image_segmentation.py +3 -0
  27. modelbrief-0.2.1/examples/computer_vision/object_detection.py +2 -0
  28. modelbrief-0.2.1/examples/nlp/sentiment_analysis.py +1 -0
  29. modelbrief-0.2.1/examples/nlp/text_classification.py +5 -0
  30. modelbrief-0.2.1/examples/nlp/text_generation.py +2 -0
  31. modelbrief-0.2.1/examples/nlp/transformers_example.py +3 -0
  32. modelbrief-0.2.1/examples/pytorch.py +5 -0
  33. modelbrief-0.2.1/examples/regression.py +5 -0
  34. modelbrief-0.2.1/examples/tensorflow_example.py +4 -0
  35. modelbrief-0.2.1/examples/time_series.py +4 -0
  36. modelbrief-0.2.1/modelbrief/__init__.py +5 -0
  37. modelbrief-0.2.1/modelbrief/adapters/__init__.py +0 -0
  38. modelbrief-0.2.1/modelbrief/adapters/base.py +26 -0
  39. modelbrief-0.2.1/modelbrief/adapters/computer_vision/__init__.py +0 -0
  40. modelbrief-0.2.1/modelbrief/adapters/computer_vision/image_models.py +5 -0
  41. modelbrief-0.2.1/modelbrief/adapters/computer_vision/pytorch_vision.py +2 -0
  42. modelbrief-0.2.1/modelbrief/adapters/computer_vision/tensorflow_vision.py +2 -0
  43. modelbrief-0.2.1/modelbrief/adapters/deep_learning/__init__.py +0 -0
  44. modelbrief-0.2.1/modelbrief/adapters/deep_learning/pytorch.py +26 -0
  45. modelbrief-0.2.1/modelbrief/adapters/deep_learning/tensorflow.py +10 -0
  46. modelbrief-0.2.1/modelbrief/adapters/nlp/__init__.py +0 -0
  47. modelbrief-0.2.1/modelbrief/adapters/nlp/pytorch_nlp.py +2 -0
  48. modelbrief-0.2.1/modelbrief/adapters/nlp/tensorflow_nlp.py +2 -0
  49. modelbrief-0.2.1/modelbrief/adapters/nlp/transformers.py +11 -0
  50. modelbrief-0.2.1/modelbrief/adapters/tabular/__init__.py +0 -0
  51. modelbrief-0.2.1/modelbrief/adapters/tabular/catboost.py +4 -0
  52. modelbrief-0.2.1/modelbrief/adapters/tabular/lightgbm.py +4 -0
  53. modelbrief-0.2.1/modelbrief/adapters/tabular/sklearn.py +17 -0
  54. modelbrief-0.2.1/modelbrief/adapters/tabular/xgboost.py +4 -0
  55. modelbrief-0.2.1/modelbrief/ai/__init__.py +0 -0
  56. modelbrief-0.2.1/modelbrief/ai/explainer.py +24 -0
  57. modelbrief-0.2.1/modelbrief/ai/providers/__init__.py +0 -0
  58. modelbrief-0.2.1/modelbrief/ai/providers/base.py +4 -0
  59. modelbrief-0.2.1/modelbrief/ai/providers/groq.py +45 -0
  60. modelbrief-0.2.1/modelbrief/ai/recommender.py +23 -0
  61. modelbrief-0.2.1/modelbrief/analysis/__init__.py +0 -0
  62. modelbrief-0.2.1/modelbrief/analysis/anomaly_detection.py +2 -0
  63. modelbrief-0.2.1/modelbrief/analysis/classification.py +2 -0
  64. modelbrief-0.2.1/modelbrief/analysis/clustering.py +2 -0
  65. modelbrief-0.2.1/modelbrief/analysis/computer_vision.py +2 -0
  66. modelbrief-0.2.1/modelbrief/analysis/dataset.py +12 -0
  67. modelbrief-0.2.1/modelbrief/analysis/dimensionality_reduction.py +2 -0
  68. modelbrief-0.2.1/modelbrief/analysis/image_segmentation.py +2 -0
  69. modelbrief-0.2.1/modelbrief/analysis/model.py +2 -0
  70. modelbrief-0.2.1/modelbrief/analysis/nlp.py +2 -0
  71. modelbrief-0.2.1/modelbrief/analysis/object_detection.py +3 -0
  72. modelbrief-0.2.1/modelbrief/analysis/regression.py +2 -0
  73. modelbrief-0.2.1/modelbrief/analysis/sentiment.py +1 -0
  74. modelbrief-0.2.1/modelbrief/analysis/text_classification.py +1 -0
  75. modelbrief-0.2.1/modelbrief/analysis/text_generation.py +2 -0
  76. modelbrief-0.2.1/modelbrief/analysis/time_series.py +2 -0
  77. modelbrief-0.2.1/modelbrief/core/__init__.py +0 -0
  78. modelbrief-0.2.1/modelbrief/core/context.py +20 -0
  79. modelbrief-0.2.1/modelbrief/core/detector.py +90 -0
  80. modelbrief-0.2.1/modelbrief/core/report.py +94 -0
  81. modelbrief-0.2.1/modelbrief/core/result.py +23 -0
  82. modelbrief-0.2.1/modelbrief/metrics/__init__.py +0 -0
  83. modelbrief-0.2.1/modelbrief/metrics/anomaly_detection.py +3 -0
  84. modelbrief-0.2.1/modelbrief/metrics/classification.py +10 -0
  85. modelbrief-0.2.1/modelbrief/metrics/clustering.py +6 -0
  86. modelbrief-0.2.1/modelbrief/metrics/nlp.py +2 -0
  87. modelbrief-0.2.1/modelbrief/metrics/object_detection.py +2 -0
  88. modelbrief-0.2.1/modelbrief/metrics/regression.py +6 -0
  89. modelbrief-0.2.1/modelbrief/metrics/segmentation.py +3 -0
  90. modelbrief-0.2.1/modelbrief/metrics/time_series.py +7 -0
  91. modelbrief-0.2.1/modelbrief/metrics/vision.py +1 -0
  92. modelbrief-0.2.1/modelbrief/output/__init__.py +0 -0
  93. modelbrief-0.2.1/modelbrief/output/console.py +9 -0
  94. modelbrief-0.2.1/modelbrief/output/html.py +128 -0
  95. modelbrief-0.2.1/modelbrief/output/pdf.py +159 -0
  96. modelbrief-0.2.1/modelbrief/visualization/__init__.py +0 -0
  97. modelbrief-0.2.1/modelbrief/visualization/confusion_matrix.py +7 -0
  98. modelbrief-0.2.1/modelbrief/visualization/detection.py +6 -0
  99. modelbrief-0.2.1/modelbrief/visualization/distributions.py +3 -0
  100. modelbrief-0.2.1/modelbrief/visualization/errors.py +1 -0
  101. modelbrief-0.2.1/modelbrief/visualization/feature_importance.py +3 -0
  102. modelbrief-0.2.1/modelbrief/visualization/image_predictions.py +2 -0
  103. modelbrief-0.2.1/modelbrief/visualization/image_samples.py +5 -0
  104. modelbrief-0.2.1/modelbrief/visualization/nlp.py +1 -0
  105. modelbrief-0.2.1/modelbrief/visualization/residuals.py +3 -0
  106. modelbrief-0.2.1/modelbrief/visualization/segmentation.py +3 -0
  107. modelbrief-0.2.1/modelbrief/visualization/text_errors.py +1 -0
  108. modelbrief-0.2.1/modelbrief/visualization/token_analysis.py +2 -0
  109. modelbrief-0.2.1/modelbrief/visualization/vision.py +3 -0
  110. modelbrief-0.2.1/pyproject.toml +28 -0
  111. modelbrief-0.2.1/python +0 -0
  112. modelbrief-0.2.1/tests/__init__.py +0 -0
  113. modelbrief-0.2.1/tests/fixtures/__init__.py +0 -0
  114. modelbrief-0.2.1/tests/fixtures/images.py +2 -0
  115. modelbrief-0.2.1/tests/fixtures/tabular.py +3 -0
  116. modelbrief-0.2.1/tests/fixtures/text.py +1 -0
  117. modelbrief-0.2.1/tests/integration/__init__.py +0 -0
  118. modelbrief-0.2.1/tests/integration/test_lightgbm.py +3 -0
  119. modelbrief-0.2.1/tests/integration/test_nlp.py +3 -0
  120. modelbrief-0.2.1/tests/integration/test_pytorch.py +3 -0
  121. modelbrief-0.2.1/tests/integration/test_sklearn.py +9 -0
  122. modelbrief-0.2.1/tests/integration/test_tensorflow.py +3 -0
  123. modelbrief-0.2.1/tests/integration/test_vision.py +3 -0
  124. modelbrief-0.2.1/tests/integration/test_xgboost.py +3 -0
  125. modelbrief-0.2.1/tests/unit/__init__.py +0 -0
  126. modelbrief-0.2.1/tests/unit/adapters/__init__.py +0 -0
  127. modelbrief-0.2.1/tests/unit/analysis/__init__.py +0 -0
  128. modelbrief-0.2.1/tests/unit/core/__init__.py +0 -0
  129. modelbrief-0.2.1/tests/unit/core/test_no_fit.py +31 -0
  130. modelbrief-0.2.1/tests/unit/metrics/__init__.py +0 -0
  131. modelbrief-0.2.1/tests/unit/metrics/test_metrics.py +5 -0
  132. modelbrief-0.2.1/tests/unit/visualization/__init__.py +0 -0
  133. modelbrief-0.2.1/uv.lock +4 -0
modelbrief-0.2.1/.github/ISSUE_TEMPLATE/bug_report.md ADDED
@@ -0,0 +1,8 @@
1
+ ---
2
+ name: Bug report
3
+ about: Report a reproducible defect
4
+ ---
5
+ **Environment**
6
+ **Model family**
7
+ **Minimal reproduction**
8
+ **Traceback**
modelbrief-0.2.1/.github/ISSUE_TEMPLATE/feature_request.md ADDED
@@ -0,0 +1,6 @@
1
+ ---
2
+ name: Feature request
3
+ about: Suggest an integration or analysis
4
+ ---
5
+ **Use case**
6
+ **Proposed behavior**
modelbrief-0.2.1/.github/pull_request_template.md ADDED
@@ -0,0 +1,5 @@
1
+ ## Summary
2
+ ## Tests
3
+ - [ ] `pytest` passes
4
+ - [ ] Optional dependencies remain optional
5
+ - [ ] No secrets or weights included
modelbrief-0.2.1/.github/workflows/build.yml ADDED
@@ -0,0 +1,11 @@
1
+ name: build
2
+ on: {push: {tags: ["v*"]}}
3
+ jobs:
4
+ build:
5
+ runs-on: ubuntu-latest
6
+ steps:
7
+ - uses: actions/checkout@v4
8
+ - uses: actions/setup-python@v5
9
+ with: {python-version: "3.12"}
10
+ - run: pip install build
11
+ - run: python -m build
modelbrief-0.2.1/.github/workflows/tests.yml ADDED
@@ -0,0 +1,14 @@
1
+ name: tests
2
+ on: [push, pull_request]
3
+ jobs:
4
+ test:
5
+ runs-on: ubuntu-latest
6
+ strategy:
7
+ matrix:
8
+ python-version: ["3.10", "3.11", "3.12"]
9
+ steps:
10
+ - uses: actions/checkout@v4
11
+ - uses: actions/setup-python@v5
12
+ with: {python-version: "${{ matrix.python-version }}"}
13
+ - run: pip install -e ".[dev]"
14
+ - run: pytest
modelbrief-0.2.1/.gitignore ADDED
@@ -0,0 +1,12 @@
1
+ .venv/
2
+ __pycache__/
3
+ *.py[cod]
4
+ .pytest_cache/
5
+ dist/
6
+ build/
7
+ *.egg-info/
8
+ .env
9
+ reports/
10
+ *.pt
11
+ *.pth
12
+ *.h5