diff --git a/.github/workflows/quarto-docs.yaml b/.github/workflows/quarto-docs.yaml index bcfba283f..4cfdabaac 100644 --- a/.github/workflows/quarto-docs.yaml +++ b/.github/workflows/quarto-docs.yaml @@ -49,27 +49,11 @@ jobs: - name: Generate Quarto Docs run: make quarto-docs - - name: Create Pull Request - id: cpr - uses: peter-evans/create-pull-request@v5 + - name: Commit changes + uses: EndBug/add-and-commit@v9 with: - token: ${{ secrets.GH_TOKEN }} - commit-message: "Generate quarto docs" - title: "Generate quarto docs" - body: | - Auto-generated PR to update Quarto documentation. - - ${{ github.event.inputs.note || 'Triggered by push to main' }} - branch: quarto-docs-update - delete-branch: true - add-paths: | - docs/ - - # Requires auto-merge to be enabled - # - name: Enable Pull Request Automerge - # if: steps.cpr.outputs.pull-request-operation == 'created' - # uses: peter-evans/enable-pull-request-automerge@v3 - # with: - # token: ${{ secrets.GH_TOKEN }} - # pull-request-number: ${{ steps.cpr.outputs.pull-request-number }} - # merge-method: squash + default_author: github_actions + message: "Generate quarto docs" + add: "docs/" + pathspec_error_handling: ignore + push: true diff --git a/docs/_sidebar.yml b/docs/_sidebar.yml index 008da78d1..9683b355b 100644 --- a/docs/_sidebar.yml +++ b/docs/_sidebar.yml @@ -10,7 +10,7 @@ website: - text: "---" - text: "Python API" # Root level items from validmind.qmd - - text: "`2.8.25`" + - text: "`2.9.5`" file: validmind/validmind.qmd#version__ - text: "init" file: validmind/validmind.qmd#init @@ -40,6 +40,8 @@ website: file: validmind/validmind.qmd#tasks - text: "test" file: validmind/validmind.qmd#test + - text: "scorer_decorator" + file: validmind/validmind.qmd#scorer_decorator - text: "log_text" file: validmind/validmind.qmd#log_text - text: "experimental_agent" @@ -75,6 +77,13 @@ website: file: validmind/validmind/datasets/credit_risk/lending_club.qmd - text: "lending_club_bias" file: validmind/validmind/datasets/credit_risk/lending_club_bias.qmd + - text: "llm" + file: validmind/validmind/datasets/llm.qmd + contents: + - text: "rag" + file: validmind/validmind/datasets/llm/rag.qmd + - text: "rfp" + file: validmind/validmind/datasets/llm/rag/rfp.qmd - text: "nlp" file: validmind/validmind/datasets/nlp.qmd contents: @@ -91,6 +100,8 @@ website: file: validmind/validmind/datasets/regression/lending_club.qmd - text: "errors" file: validmind/validmind/errors.qmd + - text: "scorer" + file: validmind/validmind/scorer.qmd - text: "test_suites" file: validmind/validmind/test_suites.qmd contents: @@ -407,6 +418,17 @@ website: file: validmind/validmind/tests/model_validation/statsmodels.qmd - text: "statsutils" file: validmind/validmind/tests/model_validation/statsmodels/statsutils.qmd + - text: "plots" + file: validmind/validmind/tests/plots.qmd + contents: + - text: "BoxPlot" + file: validmind/validmind/tests/plots/BoxPlot.qmd + - text: "CorrelationHeatmap" + file: validmind/validmind/tests/plots/CorrelationHeatmap.qmd + - text: "HistogramPlot" + file: validmind/validmind/tests/plots/HistogramPlot.qmd + - text: "ViolinPlot" + file: validmind/validmind/tests/plots/ViolinPlot.qmd - text: "prompt_validation" file: validmind/validmind/tests/prompt_validation.qmd contents: @@ -426,6 +448,17 @@ website: file: validmind/validmind/tests/prompt_validation/Specificity.qmd - text: "ai_powered_test" file: validmind/validmind/tests/prompt_validation/ai_powered_test.qmd + - text: "stats" + file: validmind/validmind/tests/stats.qmd + contents: + - text: "CorrelationAnalysis" + file: validmind/validmind/tests/stats/CorrelationAnalysis.qmd + - text: "DescriptiveStats" + file: validmind/validmind/tests/stats/DescriptiveStats.qmd + - text: "NormalityTests" + file: validmind/validmind/tests/stats/NormalityTests.qmd + - text: "OutlierDetection" + file: validmind/validmind/tests/stats/OutlierDetection.qmd - text: "unit_metrics" file: validmind/validmind/unit_metrics.qmd - text: "vm_models" diff --git a/docs/validmind.qmd b/docs/validmind.qmd index d9b834caf..3fa4c1e74 100644 --- a/docs/validmind.qmd +++ b/docs/validmind.qmd @@ -27,7 +27,7 @@ To initialize the ValidMind Library, paste the code snippet with the model ident import validmind as vm vm.init( - api_host = "https://api.dev.vm.validmind.ai/api/v1/tracking/tracking", + api_host = "https://app.prod.validmind.ai/api/v1/tracking/tracking", api_key = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", api_secret = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", project = "" @@ -44,7 +44,7 @@ After you have pasted the code snippet into your development source code and exe ::: {.signature} -2.8.25 +2.9.5 ::: @@ -66,7 +66,7 @@ If the API key and secret are not provided, the client will attempt to retrieve **Arguments** -- `project (str, optional)`: The project CUID. Alias for model. Defaults to None. \[DEPRECATED\] +- `project (str, optional)`: The project CUID. Alias for model. Defaults to None. [DEPRECATED] - `model (str, optional)`: The model CUID. Defaults to None. - `api_key (str, optional)`: The API key. Defaults to None. - `api_secret (str, optional)`: The API secret. Defaults to None. @@ -213,7 +213,7 @@ This function provides an interface to retrieve the TestSuite instance for the c ::: {.signature} -deflog_metric(key:str,value:float,inputs:Optional\[List\[str\]\]=None,params:Optional\[Dict\[str, Any\]\]=None,recorded_at:Optional\[str\]=None,thresholds:Optional\[Dict\[str, Any\]\]=None,passed:Optional\[bool\]=None): +deflog_metric(key:str,value:Union\[int, float\],inputs:Optional\[List\[str\]\]=None,params:Optional\[Dict\[str, Any\]\]=None,recorded_at:Optional\[str\]=None,thresholds:Optional\[Dict\[str, Any\]\]=None,passed:Optional\[bool\]=None): ::: @@ -226,11 +226,12 @@ Unit metrics are key-value pairs where the key is the metric name and the value **Arguments** - `key (str)`: The metric key -- `value (Union[int, float])`: The metric value +- `value (Union[int, float])`: The metric value (scalar) - `inputs (List[str])`: List of input IDs - `params (Dict[str, Any])`: Parameters used to generate the metric - `recorded_at (str)`: Timestamp when the metric was recorded - `thresholds (Dict[str, Any])`: Thresholds for the metric +- `passed (bool)`: Whether the metric passed validation thresholds ## preview_template @@ -422,6 +423,61 @@ The function may also include a docstring. This docstring will be used and logge - The decorated function. +## scorer_decorator + + + +::: {.signature} + +defscorer(func_or_id:Union\[Callable\[..., Any\], str, None\]=None) → Callable\[\[validmind.vm_models.F\], validmind.vm_models.F\]: + +::: + + + +Decorator for creating and registering custom scorers + +This decorator registers the function it wraps as a scorer function within ValidMind under the provided ID. Once decorated, the function can be run using the `validmind.scorer.run_scorer` function. + +The scorer ID can be provided in three ways: + +1. Explicit ID: `@scorer("validmind.scorer.classification.BrierScore")` +1. Auto-generated from path: `@scorer()` - automatically generates ID from file path +1. Function name only: `@scorer` - uses function name with validmind.scorer prefix + +The function can take two different types of arguments: + +- Inputs: ValidMind model or dataset (or list of models/datasets). These arguments must use the following names: `model`, `models`, `dataset`, `datasets`. +- Parameters: Any additional keyword arguments of any type (must have a default value) that can have any name. + +The function should return one of the following types: + +- Table: Either a list of dictionaries or a pandas DataFrame +- Plot: Either a matplotlib figure or a plotly figure +- Scalar: A single number (int or float) +- Boolean: A single boolean value indicating whether the test passed or failed +- List: A list of values (for row-level metrics) or a list of dictionaries with consistent keys +- Any other type: The output will be stored as raw data for use by calling code + +When returning a list of dictionaries: + +- All dictionaries must have the same keys +- The list length must match the number of rows in the dataset +- Each dictionary key will become a separate column when using assign_scores +- Column naming follows the pattern: {model_id}_{metric_name}_{dict_key} + +Note: Scorer outputs are not logged to the backend and are intended for use by other parts of the system (e.g., assign_scores method). + +The function may also include a docstring. This docstring will be used and logged as the scorer's description. + +**Arguments** + +- `func_or_id (Union[Callable[..., Any], str, None], optional)`: Either the function to decorate or the scorer ID. If None or empty string, the ID is auto-generated from the file path. Defaults to None. + +**Returns** + +- The decorated function. + ## log_text diff --git a/docs/validmind/datasets.qmd b/docs/validmind/datasets.qmd index f02b4a9c9..2c075342e 100644 --- a/docs/validmind/datasets.qmd +++ b/docs/validmind/datasets.qmd @@ -12,5 +12,6 @@ Example datasets that can be used with the ValidMind Library. - [classification](datasets/classification.qmd) - [credit_risk](datasets/credit_risk.qmd) +- [llm](datasets/llm.qmd) - [nlp](datasets/nlp.qmd) - [regression](datasets/regression.qmd) diff --git a/docs/validmind/tests.qmd b/docs/validmind/tests.qmd index 31cb60882..18e1bb0d4 100644 --- a/docs/validmind/tests.qmd +++ b/docs/validmind/tests.qmd @@ -12,7 +12,9 @@ ValidMind Tests Module - [data_validation](tests/data_validation.qmd) - [model_validation](tests/model_validation.qmd) +- [plots](tests/plots.qmd) - [prompt_validation](tests/prompt_validation.qmd) +- [stats](tests/stats.qmd) ## list_tests @@ -85,7 +87,7 @@ This function can be used to see test details including the test name, descripti ::: {.signature} -defrun_test(test_id:Union\[TestID (Union of validmind.data_validation.\*, validmind.model_validation.\*, validmind.prompt_validation.\* and str), None\]=None,name:Union\[str, None\]=None,unit_metrics:Union\[List\[TestID (Unit metrics from validmind.unit_metrics.\*)\], None\]=None,inputs:Union\[Dict\[str, Any\], None\]=None,input_grid:Union\[Dict\[str, List\[Any\]\], List\[Dict\[str, Any\]\], None\]=None,params:Union\[Dict\[str, Any\], None\]=None,param_grid:Union\[Dict\[str, List\[Any\]\], List\[Dict\[str, Any\]\], None\]=None,show:bool=True,generate_description:bool=True,title:Optional\[str\]=None,post_process_fn:Union\[Callable\[\[validmind.vm_models.TestResult\], None\], None\]=None,show_params:bool=True,\*\*kwargs) → validmind.vm_models.TestResult: +defrun_test(test_id:Union\[TestID (Union of validmind.data_validation.\*, validmind.model_validation.\*, validmind.prompt_validation.\* and str), None\]=None,name:Union\[str, None\]=None,unit_metrics:Union\[List\[TestID (Unit metrics from validmind.unit_metrics.\*)\], None\]=None,inputs:Union\[Dict\[str, Any\], None\]=None,input_grid:Union\[Dict\[str, List\[Any\]\], List\[Dict\[str, Any\]\], None\]=None,params:Union\[Dict\[str, Any\], None\]=None,param_grid:Union\[Dict\[str, List\[Any\]\], List\[Dict\[str, Any\]\], None\]=None,show:bool=True,generate_description:bool=True,title:Optional\[str\]=None,post_process_fn:Union\[Callable\[\[validmind.vm_models.TestResult\], None\], None\]=None,show_params:bool=True,context:Union\[Dict\[str, str\], None\]=None,\*\*kwargs) → validmind.vm_models.TestResult: ::: @@ -113,6 +115,10 @@ This function is the main entry point for running tests. It can run simple unit - `title (str)`: Custom title for the test result - `post_process_fn (Callable[[TestResult], None])`: Function to post-process the test result - `show_params (bool, optional)`: Whether to include parameter values in figure titles for comparison tests. Defaults to True. +- `context (Dict[str, str])`: Context for test description generation. Supported keys: +- 'test_description': Custom docstring to override the test's built-in documentation +- 'instructions': Instructions for the LLM to format the description output +- 'additional_context': Background information for the LLM to contextualize results **Returns** @@ -207,6 +213,61 @@ The function may also include a docstring. This docstring will be used and logge - The decorated function. +## scorer + + + +::: {.signature} + +defscorer(func_or_id:Union\[Callable\[..., Any\], str, None\]=None) → Callable\[\[validmind.vm_models.F\], validmind.vm_models.F\]: + +::: + + + +Decorator for creating and registering custom scorers + +This decorator registers the function it wraps as a scorer function within ValidMind under the provided ID. Once decorated, the function can be run using the `validmind.scorer.run_scorer` function. + +The scorer ID can be provided in three ways: + +1. Explicit ID: `@scorer("validmind.scorer.classification.BrierScore")` +1. Auto-generated from path: `@scorer()` - automatically generates ID from file path +1. Function name only: `@scorer` - uses function name with validmind.scorer prefix + +The function can take two different types of arguments: + +- Inputs: ValidMind model or dataset (or list of models/datasets). These arguments must use the following names: `model`, `models`, `dataset`, `datasets`. +- Parameters: Any additional keyword arguments of any type (must have a default value) that can have any name. + +The function should return one of the following types: + +- Table: Either a list of dictionaries or a pandas DataFrame +- Plot: Either a matplotlib figure or a plotly figure +- Scalar: A single number (int or float) +- Boolean: A single boolean value indicating whether the test passed or failed +- List: A list of values (for row-level metrics) or a list of dictionaries with consistent keys +- Any other type: The output will be stored as raw data for use by calling code + +When returning a list of dictionaries: + +- All dictionaries must have the same keys +- The list length must match the number of rows in the dataset +- Each dictionary key will become a separate column when using assign_scores +- Column naming follows the pattern: {model_id}_{metric_name}_{dict_key} + +Note: Scorer outputs are not logged to the backend and are intended for use by other parts of the system (e.g., assign_scores method). + +The function may also include a docstring. This docstring will be used and logged as the scorer's description. + +**Arguments** + +- `func_or_id (Union[Callable[..., Any], str, None], optional)`: Either the function to decorate or the scorer ID. If None or empty string, the ID is auto-generated from the file path. Defaults to None. + +**Returns** + +- The decorated function. + ## tags diff --git a/docs/validmind/tests/data_validation/ACFandPACFPlot.qmd b/docs/validmind/tests/data_validation/ACFandPACFPlot.qmd index e0a4387a6..ffa255f3f 100644 --- a/docs/validmind/tests/data_validation/ACFandPACFPlot.qmd +++ b/docs/validmind/tests/data_validation/ACFandPACFPlot.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression') -defACFandPACFPlot(dataset:validmind.vm_models.VMDataset): +defACFandPACFPlot(dataset:validmind.vm_models.VMDataset) → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/ADF.qmd b/docs/validmind/tests/data_validation/ADF.qmd index cf1271f51..1742d5919 100644 --- a/docs/validmind/tests/data_validation/ADF.qmd +++ b/docs/validmind/tests/data_validation/ADF.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression') -defADF(dataset:validmind.vm_models.VMDataset): +defADF(dataset:validmind.vm_models.VMDataset) → Dict\[str, pd.DataFrame\]: ::: diff --git a/docs/validmind/tests/data_validation/AutoAR.qmd b/docs/validmind/tests/data_validation/AutoAR.qmd index d08f176be..ff41a4de1 100644 --- a/docs/validmind/tests/data_validation/AutoAR.qmd +++ b/docs/validmind/tests/data_validation/AutoAR.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression') -defAutoAR(dataset:validmind.vm_models.VMDataset,max_ar_order:int=3): +defAutoAR(dataset:validmind.vm_models.VMDataset,max_ar_order:int=3) → Dict\[str, pd.DataFrame\]: ::: diff --git a/docs/validmind/tests/data_validation/AutoMA.qmd b/docs/validmind/tests/data_validation/AutoMA.qmd index 20a4cb238..d55419847 100644 --- a/docs/validmind/tests/data_validation/AutoMA.qmd +++ b/docs/validmind/tests/data_validation/AutoMA.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression') -defAutoMA(dataset:validmind.vm_models.VMDataset,max_ma_order:int=3): +defAutoMA(dataset:validmind.vm_models.VMDataset,max_ma_order:int=3) → Tuple\[Dict\[str, pd.DataFrame\], validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/AutoStationarity.qmd b/docs/validmind/tests/data_validation/AutoStationarity.qmd index c76731266..328ff953b 100644 --- a/docs/validmind/tests/data_validation/AutoStationarity.qmd +++ b/docs/validmind/tests/data_validation/AutoStationarity.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression') -defAutoStationarity(dataset:validmind.vm_models.VMDataset,max_order:int=5,threshold:float=0.05): +defAutoStationarity(dataset:validmind.vm_models.VMDataset,max_order:int=5,threshold:float=0.05) → Dict\[str, pd.DataFrame\]: ::: diff --git a/docs/validmind/tests/data_validation/BivariateScatterPlots.qmd b/docs/validmind/tests/data_validation/BivariateScatterPlots.qmd index aed572dd6..5254ee752 100644 --- a/docs/validmind/tests/data_validation/BivariateScatterPlots.qmd +++ b/docs/validmind/tests/data_validation/BivariateScatterPlots.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification') -defBivariateScatterPlots(dataset): +defBivariateScatterPlots(dataset) → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/BoxPierce.qmd b/docs/validmind/tests/data_validation/BoxPierce.qmd index 0f8d08564..cdc138fc5 100644 --- a/docs/validmind/tests/data_validation/BoxPierce.qmd +++ b/docs/validmind/tests/data_validation/BoxPierce.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tags('time_series_data', 'forecasting', 'statistical_test', 'statsmodels') -defBoxPierce(dataset): +defBoxPierce(dataset) → Tuple\[pd.DataFrame, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/ChiSquaredFeaturesTable.qmd b/docs/validmind/tests/data_validation/ChiSquaredFeaturesTable.qmd index e71f3e3f2..794dc71eb 100644 --- a/docs/validmind/tests/data_validation/ChiSquaredFeaturesTable.qmd +++ b/docs/validmind/tests/data_validation/ChiSquaredFeaturesTable.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification') -defChiSquaredFeaturesTable(dataset,p_threshold=0.05): +defChiSquaredFeaturesTable(dataset,p_threshold=0.05) → pd.DataFrame: ::: diff --git a/docs/validmind/tests/data_validation/ClassImbalance.qmd b/docs/validmind/tests/data_validation/ClassImbalance.qmd index 4506dd76d..39799afe0 100644 --- a/docs/validmind/tests/data_validation/ClassImbalance.qmd +++ b/docs/validmind/tests/data_validation/ClassImbalance.qmd @@ -22,7 +22,7 @@ Threshold based tests @tasks('classification') -defClassImbalance(dataset:validmind.vm_models.VMDataset,min_percent_threshold:int=10) → Tuple\[Dict\[str, Any\], go.Figure, bool\]: +defClassImbalance(dataset:validmind.vm_models.VMDataset,min_percent_threshold:int=10) → Tuple\[Dict\[str, Any\], go.Figure, bool, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/DatasetDescription.qmd b/docs/validmind/tests/data_validation/DatasetDescription.qmd index c3c8e31fc..bdd706f47 100644 --- a/docs/validmind/tests/data_validation/DatasetDescription.qmd +++ b/docs/validmind/tests/data_validation/DatasetDescription.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'regression', 'text_classification', 'text_summarization') -defDatasetDescription(dataset:validmind.vm_models.VMDataset): +defDatasetDescription(dataset:validmind.vm_models.VMDataset) → Tuple\[Dict\[str, List\[Dict\[str, Any\]\]\], validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/DatasetSplit.qmd b/docs/validmind/tests/data_validation/DatasetSplit.qmd index dd682148f..e2c259bec 100644 --- a/docs/validmind/tests/data_validation/DatasetSplit.qmd +++ b/docs/validmind/tests/data_validation/DatasetSplit.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'regression', 'text_classification', 'text_summarization') -defDatasetSplit(datasets:List\[validmind.vm_models.VMDataset\]): +defDatasetSplit(datasets:List\[validmind.vm_models.VMDataset\]) → Tuple\[List\[Dict\[str, Any\]\], validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/DescriptiveStatistics.qmd b/docs/validmind/tests/data_validation/DescriptiveStatistics.qmd index d2fa820db..856687c1b 100644 --- a/docs/validmind/tests/data_validation/DescriptiveStatistics.qmd +++ b/docs/validmind/tests/data_validation/DescriptiveStatistics.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'regression') -defDescriptiveStatistics(dataset:validmind.vm_models.VMDataset): +defDescriptiveStatistics(dataset:validmind.vm_models.VMDataset) → Dict\[str, Any\]: ::: diff --git a/docs/validmind/tests/data_validation/DickeyFullerGLS.qmd b/docs/validmind/tests/data_validation/DickeyFullerGLS.qmd index f7d9c1e07..643f1ed2a 100644 --- a/docs/validmind/tests/data_validation/DickeyFullerGLS.qmd +++ b/docs/validmind/tests/data_validation/DickeyFullerGLS.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression') -defDickeyFullerGLS(dataset:validmind.vm_models.VMDataset): +defDickeyFullerGLS(dataset:validmind.vm_models.VMDataset) → Tuple\[Dict\[str, Any\], validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/Duplicates.qmd b/docs/validmind/tests/data_validation/Duplicates.qmd index 682fa9eeb..c11a5a923 100644 --- a/docs/validmind/tests/data_validation/Duplicates.qmd +++ b/docs/validmind/tests/data_validation/Duplicates.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'regression') -defDuplicates(dataset,min_threshold=1): +defDuplicates(dataset,min_threshold=1) → Tuple\[Dict\[str, Any\], bool\]: ::: diff --git a/docs/validmind/tests/data_validation/EngleGrangerCoint.qmd b/docs/validmind/tests/data_validation/EngleGrangerCoint.qmd index 98121b529..dcf4dedda 100644 --- a/docs/validmind/tests/data_validation/EngleGrangerCoint.qmd +++ b/docs/validmind/tests/data_validation/EngleGrangerCoint.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression') -defEngleGrangerCoint(dataset:validmind.vm_models.VMDataset,threshold:float=0.05): +defEngleGrangerCoint(dataset:validmind.vm_models.VMDataset,threshold:float=0.05) → Dict\[str, pd.DataFrame\]: ::: diff --git a/docs/validmind/tests/data_validation/FeatureTargetCorrelationPlot.qmd b/docs/validmind/tests/data_validation/FeatureTargetCorrelationPlot.qmd index 6300fb261..ffd473456 100644 --- a/docs/validmind/tests/data_validation/FeatureTargetCorrelationPlot.qmd +++ b/docs/validmind/tests/data_validation/FeatureTargetCorrelationPlot.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'regression') -defFeatureTargetCorrelationPlot(dataset,fig_height=600): +defFeatureTargetCorrelationPlot(dataset,fig_height=600) → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/HighCardinality.qmd b/docs/validmind/tests/data_validation/HighCardinality.qmd index 9bae65aaa..37b7b18dd 100644 --- a/docs/validmind/tests/data_validation/HighCardinality.qmd +++ b/docs/validmind/tests/data_validation/HighCardinality.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'regression') -defHighCardinality(dataset:validmind.vm_models.VMDataset,num_threshold:int=100,percent_threshold:float=0.1,threshold_type:str='percent'): +defHighCardinality(dataset:validmind.vm_models.VMDataset,num_threshold:int=100,percent_threshold:float=0.1,threshold_type:str='percent') → Tuple\[List\[Dict\[str, Any\]\], bool, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/HighPearsonCorrelation.qmd b/docs/validmind/tests/data_validation/HighPearsonCorrelation.qmd index f7becf783..0c1e96976 100644 --- a/docs/validmind/tests/data_validation/HighPearsonCorrelation.qmd +++ b/docs/validmind/tests/data_validation/HighPearsonCorrelation.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'regression') -defHighPearsonCorrelation(dataset:validmind.vm_models.VMDataset,max_threshold:float=0.3,top_n_correlations:int=10,feature_columns:list=None): +defHighPearsonCorrelation(dataset:validmind.vm_models.VMDataset,max_threshold:float=0.3,top_n_correlations:int=10,feature_columns:list=None) → Tuple\[List\[Dict\[str, Any\]\], bool, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/IQROutliersBarPlot.qmd b/docs/validmind/tests/data_validation/IQROutliersBarPlot.qmd index ca5ed977d..796ebd2fe 100644 --- a/docs/validmind/tests/data_validation/IQROutliersBarPlot.qmd +++ b/docs/validmind/tests/data_validation/IQROutliersBarPlot.qmd @@ -30,7 +30,7 @@ toc-expand: 4 @tasks('classification', 'regression') -defIQROutliersBarPlot(dataset:validmind.vm_models.VMDataset,threshold:float=1.5,fig_width:int=800): +defIQROutliersBarPlot(dataset:validmind.vm_models.VMDataset,threshold:float=1.5,fig_width:int=800) → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: @@ -49,7 +49,7 @@ The examination invokes a series of steps: 1. For every numeric feature in the dataset, the 25th percentile (Q1) and 75th percentile (Q3) are calculated before deriving the Interquartile Range (IQR), the difference between Q1 and Q3. 1. Subsequently, the metric calculates the lower and upper thresholds by subtracting Q1 from the `threshold` times IQR and adding Q3 to `threshold` times IQR, respectively. The default `threshold` is set at 1.5. 1. Any value in the feature that falls below the lower threshold or exceeds the upper threshold is labeled as an outlier. -1. The number of outliers are tallied for different percentiles, such as \[0-25\], \[25-50\], \[50-75\], and \[75-100\]. +1. The number of outliers are tallied for different percentiles, such as [0-25], [25-50], [50-75], and [75-100]. 1. These counts are employed to construct a bar plot for the feature, showcasing the distribution of outliers across different percentiles. ### Signs of High Risk diff --git a/docs/validmind/tests/data_validation/IQROutliersTable.qmd b/docs/validmind/tests/data_validation/IQROutliersTable.qmd index 824bdcb20..4d972b664 100644 --- a/docs/validmind/tests/data_validation/IQROutliersTable.qmd +++ b/docs/validmind/tests/data_validation/IQROutliersTable.qmd @@ -30,7 +30,7 @@ toc-expand: 4 @tasks('classification', 'regression') -defIQROutliersTable(dataset:validmind.vm_models.VMDataset,threshold:float=1.5): +defIQROutliersTable(dataset:validmind.vm_models.VMDataset,threshold:float=1.5) → Tuple\[Dict\[str, Any\], validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/IsolationForestOutliers.qmd b/docs/validmind/tests/data_validation/IsolationForestOutliers.qmd index 2c2659aa9..3ca95ba2e 100644 --- a/docs/validmind/tests/data_validation/IsolationForestOutliers.qmd +++ b/docs/validmind/tests/data_validation/IsolationForestOutliers.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification') -defIsolationForestOutliers(dataset:validmind.vm_models.VMDataset,random_state:int=0,contamination:float=0.1,feature_columns:list=None): +defIsolationForestOutliers(dataset:validmind.vm_models.VMDataset,random_state:int=0,contamination:float=0.1,feature_columns:list=None) → Tuple\[matplotlib.validmind.vm_models.figure.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/JarqueBera.qmd b/docs/validmind/tests/data_validation/JarqueBera.qmd index 2a1ae958f..2ae849081 100644 --- a/docs/validmind/tests/data_validation/JarqueBera.qmd +++ b/docs/validmind/tests/data_validation/JarqueBera.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tags('tabular_data', 'data_distribution', 'statistical_test', 'statsmodels') -defJarqueBera(dataset): +defJarqueBera(dataset) → Tuple\[pd.DataFrame, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/KPSS.qmd b/docs/validmind/tests/data_validation/KPSS.qmd index 4e3db67fd..c626ab5d6 100644 --- a/docs/validmind/tests/data_validation/KPSS.qmd +++ b/docs/validmind/tests/data_validation/KPSS.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('data_validation') -defKPSS(dataset:validmind.vm_models.VMDataset): +defKPSS(dataset:validmind.vm_models.VMDataset) → Dict\[str, Any\]: ::: diff --git a/docs/validmind/tests/data_validation/LJungBox.qmd b/docs/validmind/tests/data_validation/LJungBox.qmd index 867019263..fb76a292e 100644 --- a/docs/validmind/tests/data_validation/LJungBox.qmd +++ b/docs/validmind/tests/data_validation/LJungBox.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tags('time_series_data', 'forecasting', 'statistical_test', 'statsmodels') -defLJungBox(dataset): +defLJungBox(dataset) → Tuple\[pd.DataFrame, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/LaggedCorrelationHeatmap.qmd b/docs/validmind/tests/data_validation/LaggedCorrelationHeatmap.qmd index e96b90f10..c73d43373 100644 --- a/docs/validmind/tests/data_validation/LaggedCorrelationHeatmap.qmd +++ b/docs/validmind/tests/data_validation/LaggedCorrelationHeatmap.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression') -defLaggedCorrelationHeatmap(dataset:validmind.vm_models.VMDataset,num_lags:int=10): +defLaggedCorrelationHeatmap(dataset:validmind.vm_models.VMDataset,num_lags:int=10) → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/MissingValues.qmd b/docs/validmind/tests/data_validation/MissingValues.qmd index da471664a..2fbfe8518 100644 --- a/docs/validmind/tests/data_validation/MissingValues.qmd +++ b/docs/validmind/tests/data_validation/MissingValues.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'regression') -defMissingValues(dataset:validmind.vm_models.VMDataset,min_threshold:int=1): +defMissingValues(dataset:validmind.vm_models.VMDataset,min_threshold:int=1) → Tuple\[List\[Dict\[str, Any\]\], bool, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/MissingValuesBarPlot.qmd b/docs/validmind/tests/data_validation/MissingValuesBarPlot.qmd index 8f85c8448..5d23a9922 100644 --- a/docs/validmind/tests/data_validation/MissingValuesBarPlot.qmd +++ b/docs/validmind/tests/data_validation/MissingValuesBarPlot.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'regression') -defMissingValuesBarPlot(dataset:validmind.vm_models.VMDataset,threshold:int=80,fig_height:int=600): +defMissingValuesBarPlot(dataset:validmind.vm_models.VMDataset,threshold:int=80,fig_height:int=600) → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/MutualInformation.qmd b/docs/validmind/tests/data_validation/MutualInformation.qmd index f75ad9464..47615d46e 100644 --- a/docs/validmind/tests/data_validation/MutualInformation.qmd +++ b/docs/validmind/tests/data_validation/MutualInformation.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'regression') -defMutualInformation(dataset:validmind.vm_models.VMDataset,min_threshold:float=0.01,task:str='classification'): +defMutualInformation(dataset:validmind.vm_models.VMDataset,min_threshold:float=0.01,task:str='classification') → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/PearsonCorrelationMatrix.qmd b/docs/validmind/tests/data_validation/PearsonCorrelationMatrix.qmd index 15d513cb8..d140fac92 100644 --- a/docs/validmind/tests/data_validation/PearsonCorrelationMatrix.qmd +++ b/docs/validmind/tests/data_validation/PearsonCorrelationMatrix.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'regression') -defPearsonCorrelationMatrix(dataset): +defPearsonCorrelationMatrix(dataset) → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/PhillipsPerronArch.qmd b/docs/validmind/tests/data_validation/PhillipsPerronArch.qmd index 2bbcc79c5..77ae3081e 100644 --- a/docs/validmind/tests/data_validation/PhillipsPerronArch.qmd +++ b/docs/validmind/tests/data_validation/PhillipsPerronArch.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression') -defPhillipsPerronArch(dataset:validmind.vm_models.VMDataset): +defPhillipsPerronArch(dataset:validmind.vm_models.VMDataset) → Dict\[str, Any\]: ::: diff --git a/docs/validmind/tests/data_validation/ProtectedClassesCombination.qmd b/docs/validmind/tests/data_validation/ProtectedClassesCombination.qmd index dae223206..88c60a23d 100644 --- a/docs/validmind/tests/data_validation/ProtectedClassesCombination.qmd +++ b/docs/validmind/tests/data_validation/ProtectedClassesCombination.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'regression') -defProtectedClassesCombination(dataset,model,protected_classes=None): +defProtectedClassesCombination(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel,protected_classes=None) → Tuple\[Dict\[str, pd.DataFrame\], Dict\[str, pd.DataFrame\], go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/ProtectedClassesDescription.qmd b/docs/validmind/tests/data_validation/ProtectedClassesDescription.qmd index 41d15fc9b..a618ed3fc 100644 --- a/docs/validmind/tests/data_validation/ProtectedClassesDescription.qmd +++ b/docs/validmind/tests/data_validation/ProtectedClassesDescription.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'regression') -defProtectedClassesDescription(dataset,protected_classes=None): +defProtectedClassesDescription(dataset,protected_classes=None) → Tuple\[pd.DataFrame, Union\[go.Figure, List\[go.Figure\]\], validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/ProtectedClassesDisparity.qmd b/docs/validmind/tests/data_validation/ProtectedClassesDisparity.qmd index aa8efafc2..72048296e 100644 --- a/docs/validmind/tests/data_validation/ProtectedClassesDisparity.qmd +++ b/docs/validmind/tests/data_validation/ProtectedClassesDisparity.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'regression') -defProtectedClassesDisparity(dataset,model,protected_classes=None,disparity_tolerance=1.25,metrics=\['fnr', 'fpr', 'tpr'\]): +defProtectedClassesDisparity(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel,protected_classes=None,disparity_tolerance=1.25,metrics=\['fnr', 'fpr', 'tpr'\]) → Tuple\[pd.DataFrame, List\[bytes\], Any, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/ProtectedClassesThresholdOptimizer.qmd b/docs/validmind/tests/data_validation/ProtectedClassesThresholdOptimizer.qmd index 42a2e8bd6..bd2ca215a 100644 --- a/docs/validmind/tests/data_validation/ProtectedClassesThresholdOptimizer.qmd +++ b/docs/validmind/tests/data_validation/ProtectedClassesThresholdOptimizer.qmd @@ -90,7 +90,7 @@ toc-expand: 4 @tasks('classification', 'regression') -defProtectedClassesThresholdOptimizer(dataset,pipeline=None,protected_classes=None,X_train=None,y_train=None): +defProtectedClassesThresholdOptimizer(dataset:validmind.vm_models.VMDataset,pipeline=None,protected_classes=None,X_train=None,y_train=None) → Tuple\[Dict\[str, Any\], matplotlib.validmind.vm_models.figure.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/RollingStatsPlot.qmd b/docs/validmind/tests/data_validation/RollingStatsPlot.qmd index 6e432c13c..b0b48a835 100644 --- a/docs/validmind/tests/data_validation/RollingStatsPlot.qmd +++ b/docs/validmind/tests/data_validation/RollingStatsPlot.qmd @@ -30,7 +30,7 @@ toc-expand: 4 @tasks('regression') -defRollingStatsPlot(dataset:validmind.vm_models.VMDataset,window_size:int=12): +defRollingStatsPlot(dataset:validmind.vm_models.VMDataset,window_size:int=12) → Tuple\[plt.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/RunsTest.qmd b/docs/validmind/tests/data_validation/RunsTest.qmd index 61b6ec3e1..3b6506228 100644 --- a/docs/validmind/tests/data_validation/RunsTest.qmd +++ b/docs/validmind/tests/data_validation/RunsTest.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tags('tabular_data', 'statistical_test', 'statsmodels') -defRunsTest(dataset): +defRunsTest(dataset) → pd.DataFrame: ::: diff --git a/docs/validmind/tests/data_validation/ScatterPlot.qmd b/docs/validmind/tests/data_validation/ScatterPlot.qmd index 0da71096d..3f1044f4d 100644 --- a/docs/validmind/tests/data_validation/ScatterPlot.qmd +++ b/docs/validmind/tests/data_validation/ScatterPlot.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'regression') -defScatterPlot(dataset): +defScatterPlot(dataset) → matplotlib.validmind.vm_models.figure.Figure: ::: diff --git a/docs/validmind/tests/data_validation/ScoreBandDefaultRates.qmd b/docs/validmind/tests/data_validation/ScoreBandDefaultRates.qmd index 7369e8ad6..e3393f7e1 100644 --- a/docs/validmind/tests/data_validation/ScoreBandDefaultRates.qmd +++ b/docs/validmind/tests/data_validation/ScoreBandDefaultRates.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification') -defScoreBandDefaultRates(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel,score_column:str='score',score_bands:list=None): +defScoreBandDefaultRates(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel,score_column:str='score',score_bands:list=None) → Tuple\[pd.DataFrame, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/SeasonalDecompose.qmd b/docs/validmind/tests/data_validation/SeasonalDecompose.qmd index ab267d4da..804a8c7d2 100644 --- a/docs/validmind/tests/data_validation/SeasonalDecompose.qmd +++ b/docs/validmind/tests/data_validation/SeasonalDecompose.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression') -defSeasonalDecompose(dataset:validmind.vm_models.VMDataset,seasonal_model:str='additive'): +defSeasonalDecompose(dataset:validmind.vm_models.VMDataset,seasonal_model:str='additive') → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/ShapiroWilk.qmd b/docs/validmind/tests/data_validation/ShapiroWilk.qmd index 33806279a..9b33b9867 100644 --- a/docs/validmind/tests/data_validation/ShapiroWilk.qmd +++ b/docs/validmind/tests/data_validation/ShapiroWilk.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tags('tabular_data', 'data_distribution', 'statistical_test') -defShapiroWilk(dataset): +defShapiroWilk(dataset) → Tuple\[pd.DataFrame, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/Skewness.qmd b/docs/validmind/tests/data_validation/Skewness.qmd index 114c52794..d0af948b9 100644 --- a/docs/validmind/tests/data_validation/Skewness.qmd +++ b/docs/validmind/tests/data_validation/Skewness.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'regression') -defSkewness(dataset,max_threshold=1): +defSkewness(dataset,max_threshold=1) → Tuple\[Dict\[str, List\[Dict\[str, Any\]\]\], bool\]: ::: diff --git a/docs/validmind/tests/data_validation/SpreadPlot.qmd b/docs/validmind/tests/data_validation/SpreadPlot.qmd index 9868e269a..45ef3e10b 100644 --- a/docs/validmind/tests/data_validation/SpreadPlot.qmd +++ b/docs/validmind/tests/data_validation/SpreadPlot.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression') -defSpreadPlot(dataset:validmind.vm_models.VMDataset): +defSpreadPlot(dataset:validmind.vm_models.VMDataset) → Tuple\[plt.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/TabularCategoricalBarPlots.qmd b/docs/validmind/tests/data_validation/TabularCategoricalBarPlots.qmd index 237869d09..1c0dce9d4 100644 --- a/docs/validmind/tests/data_validation/TabularCategoricalBarPlots.qmd +++ b/docs/validmind/tests/data_validation/TabularCategoricalBarPlots.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'regression') -defTabularCategoricalBarPlots(dataset:validmind.vm_models.VMDataset): +defTabularCategoricalBarPlots(dataset:validmind.vm_models.VMDataset) → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/TabularDateTimeHistograms.qmd b/docs/validmind/tests/data_validation/TabularDateTimeHistograms.qmd index 5469fb6ff..065c174a5 100644 --- a/docs/validmind/tests/data_validation/TabularDateTimeHistograms.qmd +++ b/docs/validmind/tests/data_validation/TabularDateTimeHistograms.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'regression') -defTabularDateTimeHistograms(dataset:validmind.vm_models.VMDataset): +defTabularDateTimeHistograms(dataset:validmind.vm_models.VMDataset) → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/TabularDescriptionTables.qmd b/docs/validmind/tests/data_validation/TabularDescriptionTables.qmd index 7b1c86ee7..2602e0a24 100644 --- a/docs/validmind/tests/data_validation/TabularDescriptionTables.qmd +++ b/docs/validmind/tests/data_validation/TabularDescriptionTables.qmd @@ -90,7 +90,7 @@ toc-expand: 4 @tasks('classification', 'regression') -defTabularDescriptionTables(dataset): +defTabularDescriptionTables(dataset) → Tuple\[pd.DataFrame\]: ::: diff --git a/docs/validmind/tests/data_validation/TabularNumericalHistograms.qmd b/docs/validmind/tests/data_validation/TabularNumericalHistograms.qmd index b8124e9ca..c3521ff74 100644 --- a/docs/validmind/tests/data_validation/TabularNumericalHistograms.qmd +++ b/docs/validmind/tests/data_validation/TabularNumericalHistograms.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'regression') -defTabularNumericalHistograms(dataset:validmind.vm_models.VMDataset): +defTabularNumericalHistograms(dataset:validmind.vm_models.VMDataset) → Tuple\[go.Figure\]: ::: diff --git a/docs/validmind/tests/data_validation/TargetRateBarPlots.qmd b/docs/validmind/tests/data_validation/TargetRateBarPlots.qmd index d055f8bd2..4ca10891e 100644 --- a/docs/validmind/tests/data_validation/TargetRateBarPlots.qmd +++ b/docs/validmind/tests/data_validation/TargetRateBarPlots.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification') -defTargetRateBarPlots(dataset:validmind.vm_models.VMDataset): +defTargetRateBarPlots(dataset:validmind.vm_models.VMDataset) → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/TimeSeriesDescription.qmd b/docs/validmind/tests/data_validation/TimeSeriesDescription.qmd index d0e8baaed..d6d35e28b 100644 --- a/docs/validmind/tests/data_validation/TimeSeriesDescription.qmd +++ b/docs/validmind/tests/data_validation/TimeSeriesDescription.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression') -defTimeSeriesDescription(dataset): +defTimeSeriesDescription(dataset) → pd.DataFrame: ::: diff --git a/docs/validmind/tests/data_validation/TimeSeriesDescriptiveStatistics.qmd b/docs/validmind/tests/data_validation/TimeSeriesDescriptiveStatistics.qmd index 75dddb44e..bdf2fc125 100644 --- a/docs/validmind/tests/data_validation/TimeSeriesDescriptiveStatistics.qmd +++ b/docs/validmind/tests/data_validation/TimeSeriesDescriptiveStatistics.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression') -defTimeSeriesDescriptiveStatistics(dataset): +defTimeSeriesDescriptiveStatistics(dataset) → pd.DataFrame: ::: diff --git a/docs/validmind/tests/data_validation/TimeSeriesFrequency.qmd b/docs/validmind/tests/data_validation/TimeSeriesFrequency.qmd index e5cd2a3e6..4bc50ed9e 100644 --- a/docs/validmind/tests/data_validation/TimeSeriesFrequency.qmd +++ b/docs/validmind/tests/data_validation/TimeSeriesFrequency.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression') -defTimeSeriesFrequency(dataset:validmind.vm_models.VMDataset): +defTimeSeriesFrequency(dataset:validmind.vm_models.VMDataset) → Tuple\[List\[Dict\[str, Any\]\], go.Figure, bool, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/TimeSeriesHistogram.qmd b/docs/validmind/tests/data_validation/TimeSeriesHistogram.qmd index a59e10f23..abbc0c53c 100644 --- a/docs/validmind/tests/data_validation/TimeSeriesHistogram.qmd +++ b/docs/validmind/tests/data_validation/TimeSeriesHistogram.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression', 'time_series_forecasting') -defTimeSeriesHistogram(dataset,nbins=30): +defTimeSeriesHistogram(dataset,nbins=30) → Tuple\[go.Figure\]: ::: diff --git a/docs/validmind/tests/data_validation/TimeSeriesLinePlot.qmd b/docs/validmind/tests/data_validation/TimeSeriesLinePlot.qmd index c467e9467..37de8b884 100644 --- a/docs/validmind/tests/data_validation/TimeSeriesLinePlot.qmd +++ b/docs/validmind/tests/data_validation/TimeSeriesLinePlot.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression') -defTimeSeriesLinePlot(dataset:validmind.vm_models.VMDataset): +defTimeSeriesLinePlot(dataset:validmind.vm_models.VMDataset) → Tuple\[go.Figure\]: ::: diff --git a/docs/validmind/tests/data_validation/TimeSeriesMissingValues.qmd b/docs/validmind/tests/data_validation/TimeSeriesMissingValues.qmd index 396864c8e..f819db125 100644 --- a/docs/validmind/tests/data_validation/TimeSeriesMissingValues.qmd +++ b/docs/validmind/tests/data_validation/TimeSeriesMissingValues.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression') -defTimeSeriesMissingValues(dataset:validmind.vm_models.VMDataset,min_threshold:int=1): +defTimeSeriesMissingValues(dataset:validmind.vm_models.VMDataset,min_threshold:int=1) → Tuple\[List\[Dict\[str, Any\]\], go.Figure, go.Figure, bool, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/TimeSeriesOutliers.qmd b/docs/validmind/tests/data_validation/TimeSeriesOutliers.qmd index 75c54077f..7e88b5caa 100644 --- a/docs/validmind/tests/data_validation/TimeSeriesOutliers.qmd +++ b/docs/validmind/tests/data_validation/TimeSeriesOutliers.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression') -defTimeSeriesOutliers(dataset:validmind.vm_models.VMDataset,zscore_threshold:int=3): +defTimeSeriesOutliers(dataset:validmind.vm_models.VMDataset,zscore_threshold:int=3) → Tuple\[pd.DataFrame, List\[go.Figure\], bool, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/TooManyZeroValues.qmd b/docs/validmind/tests/data_validation/TooManyZeroValues.qmd index c01535e6a..9f2ed62c5 100644 --- a/docs/validmind/tests/data_validation/TooManyZeroValues.qmd +++ b/docs/validmind/tests/data_validation/TooManyZeroValues.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression', 'classification') -defTooManyZeroValues(dataset:validmind.vm_models.VMDataset,max_percent_threshold:float=0.03): +defTooManyZeroValues(dataset:validmind.vm_models.VMDataset,max_percent_threshold:float=0.03) → Tuple\[List\[Dict\[str, Any\]\], bool\]: ::: diff --git a/docs/validmind/tests/data_validation/UniqueRows.qmd b/docs/validmind/tests/data_validation/UniqueRows.qmd index 1bb43a4a8..018d585c6 100644 --- a/docs/validmind/tests/data_validation/UniqueRows.qmd +++ b/docs/validmind/tests/data_validation/UniqueRows.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression', 'classification') -defUniqueRows(dataset:validmind.vm_models.VMDataset,min_percent_threshold:float=1): +defUniqueRows(dataset:validmind.vm_models.VMDataset,min_percent_threshold:float=1) → Tuple\[List\[Dict\[str, Any\]\], bool\]: ::: diff --git a/docs/validmind/tests/data_validation/WOEBinPlots.qmd b/docs/validmind/tests/data_validation/WOEBinPlots.qmd index f11d7ec8f..46f23a56d 100644 --- a/docs/validmind/tests/data_validation/WOEBinPlots.qmd +++ b/docs/validmind/tests/data_validation/WOEBinPlots.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification') -defWOEBinPlots(dataset:validmind.vm_models.VMDataset,breaks_adj:list=None,fig_height:int=600,fig_width:int=500): +defWOEBinPlots(dataset:validmind.vm_models.VMDataset,breaks_adj:list=None,fig_height:int=600,fig_width:int=500) → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/WOEBinTable.qmd b/docs/validmind/tests/data_validation/WOEBinTable.qmd index 70b1292d0..3fd16167a 100644 --- a/docs/validmind/tests/data_validation/WOEBinTable.qmd +++ b/docs/validmind/tests/data_validation/WOEBinTable.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification') -defWOEBinTable(dataset:validmind.vm_models.VMDataset,breaks_adj:list=None): +defWOEBinTable(dataset:validmind.vm_models.VMDataset,breaks_adj:list=None) → Tuple\[Dict\[str, pd.DataFrame\], validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/ZivotAndrewsArch.qmd b/docs/validmind/tests/data_validation/ZivotAndrewsArch.qmd index 11030f277..b553b55e2 100644 --- a/docs/validmind/tests/data_validation/ZivotAndrewsArch.qmd +++ b/docs/validmind/tests/data_validation/ZivotAndrewsArch.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression') -defZivotAndrewsArch(dataset:validmind.vm_models.VMDataset): +defZivotAndrewsArch(dataset:validmind.vm_models.VMDataset) → Tuple\[Dict\[str, Any\], validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/nlp/CommonWords.qmd b/docs/validmind/tests/data_validation/nlp/CommonWords.qmd index a2e036f51..9c7033d44 100644 --- a/docs/validmind/tests/data_validation/nlp/CommonWords.qmd +++ b/docs/validmind/tests/data_validation/nlp/CommonWords.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('text_classification', 'text_summarization') -defCommonWords(dataset:validmind.vm_models.VMDataset): +defCommonWords(dataset:validmind.vm_models.VMDataset) → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/nlp/Hashtags.qmd b/docs/validmind/tests/data_validation/nlp/Hashtags.qmd index ca9beeea3..cc2cc2df5 100644 --- a/docs/validmind/tests/data_validation/nlp/Hashtags.qmd +++ b/docs/validmind/tests/data_validation/nlp/Hashtags.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('text_classification', 'text_summarization') -defHashtags(dataset:validmind.vm_models.VMDataset,top_hashtags:int=25): +defHashtags(dataset:validmind.vm_models.VMDataset,top_hashtags:int=25) → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/nlp/LanguageDetection.qmd b/docs/validmind/tests/data_validation/nlp/LanguageDetection.qmd index 33023a95d..e94aae017 100644 --- a/docs/validmind/tests/data_validation/nlp/LanguageDetection.qmd +++ b/docs/validmind/tests/data_validation/nlp/LanguageDetection.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('text_classification', 'text_summarization') -defLanguageDetection(dataset): +defLanguageDetection(dataset) → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/nlp/Mentions.qmd b/docs/validmind/tests/data_validation/nlp/Mentions.qmd index 6e4f4069a..9f6b99ce9 100644 --- a/docs/validmind/tests/data_validation/nlp/Mentions.qmd +++ b/docs/validmind/tests/data_validation/nlp/Mentions.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('text_classification', 'text_summarization') -defMentions(dataset:validmind.vm_models.VMDataset,top_mentions:int=25): +defMentions(dataset:validmind.vm_models.VMDataset,top_mentions:int=25) → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/nlp/PolarityAndSubjectivity.qmd b/docs/validmind/tests/data_validation/nlp/PolarityAndSubjectivity.qmd index fb166026a..7f71fca2e 100644 --- a/docs/validmind/tests/data_validation/nlp/PolarityAndSubjectivity.qmd +++ b/docs/validmind/tests/data_validation/nlp/PolarityAndSubjectivity.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('nlp') -defPolarityAndSubjectivity(dataset,threshold_subjectivity=0.5,threshold_polarity=0): +defPolarityAndSubjectivity(dataset,threshold_subjectivity=0.5,threshold_polarity=0) → Tuple\[go.Figure, Dict\[str, pd.DataFrame\], validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/nlp/Punctuations.qmd b/docs/validmind/tests/data_validation/nlp/Punctuations.qmd index 4befae9d5..3a336eaa4 100644 --- a/docs/validmind/tests/data_validation/nlp/Punctuations.qmd +++ b/docs/validmind/tests/data_validation/nlp/Punctuations.qmd @@ -22,7 +22,7 @@ Metrics functions for any Pandas-compatible datasets @tasks('text_classification', 'text_summarization', 'nlp') -defPunctuations(dataset,count_mode='token'): +defPunctuations(dataset,count_mode='token') → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/nlp/Sentiment.qmd b/docs/validmind/tests/data_validation/nlp/Sentiment.qmd index d14251e32..0b9684e1b 100644 --- a/docs/validmind/tests/data_validation/nlp/Sentiment.qmd +++ b/docs/validmind/tests/data_validation/nlp/Sentiment.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('nlp') -defSentiment(dataset): +defSentiment(dataset) → Tuple\[plt.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/nlp/StopWords.qmd b/docs/validmind/tests/data_validation/nlp/StopWords.qmd index 8aa52c38d..47eb32099 100644 --- a/docs/validmind/tests/data_validation/nlp/StopWords.qmd +++ b/docs/validmind/tests/data_validation/nlp/StopWords.qmd @@ -22,7 +22,7 @@ Threshold based tests @tasks('text_classification', 'text_summarization') -defStopWords(dataset:validmind.vm_models.VMDataset,min_percent_threshold:float=0.5,num_words:int=25): +defStopWords(dataset:validmind.vm_models.VMDataset,min_percent_threshold:float=0.5,num_words:int=25) → Tuple\[Dict\[str, pd.DataFrame\], go.Figure, bool, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/nlp/TextDescription.qmd b/docs/validmind/tests/data_validation/nlp/TextDescription.qmd index 463d89065..0ff37cfe8 100644 --- a/docs/validmind/tests/data_validation/nlp/TextDescription.qmd +++ b/docs/validmind/tests/data_validation/nlp/TextDescription.qmd @@ -30,7 +30,7 @@ toc-expand: 4 @tasks('text_classification', 'text_summarization') -defTextDescription(dataset:validmind.vm_models.VMDataset,unwanted_tokens:set={'s', "s'", 'mr', 'ms', 'mrs', 'dr', "'s", ' ', "''", 'dollar', 'us', '\`\`'},lang:str='english'): +defTextDescription(dataset:validmind.vm_models.VMDataset,unwanted_tokens:set={'s', "s'", 'mr', 'ms', 'mrs', 'dr', "'s", ' ', "''", 'dollar', 'us', '\`\`'},lang:str='english') → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/data_validation/nlp/Toxicity.qmd b/docs/validmind/tests/data_validation/nlp/Toxicity.qmd index 459834d9b..4f14ee13f 100644 --- a/docs/validmind/tests/data_validation/nlp/Toxicity.qmd +++ b/docs/validmind/tests/data_validation/nlp/Toxicity.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('nlp') -defToxicity(dataset): +defToxicity(dataset) → Tuple\[plt.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/BertScore.qmd b/docs/validmind/tests/model_validation/BertScore.qmd index 89e519ca4..160bff95f 100644 --- a/docs/validmind/tests/model_validation/BertScore.qmd +++ b/docs/validmind/tests/model_validation/BertScore.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('text_classification', 'text_summarization') -defBertScore(dataset,model,evaluation_model='distilbert-base-uncased'): +defBertScore(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel,evaluation_model='distilbert-base-uncased') → Tuple\[pd.DataFrame, go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/BleuScore.qmd b/docs/validmind/tests/model_validation/BleuScore.qmd index e43893810..5454fb756 100644 --- a/docs/validmind/tests/model_validation/BleuScore.qmd +++ b/docs/validmind/tests/model_validation/BleuScore.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('text_classification', 'text_summarization') -defBleuScore(dataset,model): +defBleuScore(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel) → Tuple\[pd.DataFrame, go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/ClusterSizeDistribution.qmd b/docs/validmind/tests/model_validation/ClusterSizeDistribution.qmd index e1a8052f7..812fc1cfc 100644 --- a/docs/validmind/tests/model_validation/ClusterSizeDistribution.qmd +++ b/docs/validmind/tests/model_validation/ClusterSizeDistribution.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('clustering') -defClusterSizeDistribution(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel): +defClusterSizeDistribution(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel) → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/ContextualRecall.qmd b/docs/validmind/tests/model_validation/ContextualRecall.qmd index 07106e637..01c9187d0 100644 --- a/docs/validmind/tests/model_validation/ContextualRecall.qmd +++ b/docs/validmind/tests/model_validation/ContextualRecall.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('text_classification', 'text_summarization') -defContextualRecall(dataset,model): +defContextualRecall(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel) → Tuple\[pd.DataFrame, go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/FeaturesAUC.qmd b/docs/validmind/tests/model_validation/FeaturesAUC.qmd index 56c68b268..1ae41cd6c 100644 --- a/docs/validmind/tests/model_validation/FeaturesAUC.qmd +++ b/docs/validmind/tests/model_validation/FeaturesAUC.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification') -defFeaturesAUC(dataset:validmind.vm_models.VMDataset,fontsize:int=12,figure_height:int=500): +defFeaturesAUC(dataset:validmind.vm_models.VMDataset,fontsize:int=12,figure_height:int=500) → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/MeteorScore.qmd b/docs/validmind/tests/model_validation/MeteorScore.qmd index 05b669cac..174efaeef 100644 --- a/docs/validmind/tests/model_validation/MeteorScore.qmd +++ b/docs/validmind/tests/model_validation/MeteorScore.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('text_classification', 'text_summarization') -defMeteorScore(dataset,model): +defMeteorScore(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel) → Tuple\[pd.DataFrame, go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/ModelMetadata.qmd b/docs/validmind/tests/model_validation/ModelMetadata.qmd index 3de4bf844..45686fc90 100644 --- a/docs/validmind/tests/model_validation/ModelMetadata.qmd +++ b/docs/validmind/tests/model_validation/ModelMetadata.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression', 'time_series_forecasting') -defModelMetadata(model): +defModelMetadata(model:validmind.vm_models.VMModel) → pd.DataFrame: ::: diff --git a/docs/validmind/tests/model_validation/ModelPredictionResiduals.qmd b/docs/validmind/tests/model_validation/ModelPredictionResiduals.qmd index fb0c40959..dc1bfd1ea 100644 --- a/docs/validmind/tests/model_validation/ModelPredictionResiduals.qmd +++ b/docs/validmind/tests/model_validation/ModelPredictionResiduals.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('residual_analysis', 'visualization') -defModelPredictionResiduals(dataset,model,nbins=100,p_value_threshold=0.05,start_date=None,end_date=None): +defModelPredictionResiduals(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel,nbins:int=100,p_value_threshold:float=0.05,start_date:Optional\[str\]=None,end_date:Optional\[str\]=None) → Tuple\[pd.DataFrame, go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/RegardScore.qmd b/docs/validmind/tests/model_validation/RegardScore.qmd index 510341da7..36bdbdeb3 100644 --- a/docs/validmind/tests/model_validation/RegardScore.qmd +++ b/docs/validmind/tests/model_validation/RegardScore.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('text_classification', 'text_summarization') -defRegardScore(dataset,model): +defRegardScore(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel) → Tuple\[pd.DataFrame, go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/RegressionResidualsPlot.qmd b/docs/validmind/tests/model_validation/RegressionResidualsPlot.qmd index 0c330d523..c3f54dc27 100644 --- a/docs/validmind/tests/model_validation/RegressionResidualsPlot.qmd +++ b/docs/validmind/tests/model_validation/RegressionResidualsPlot.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression') -defRegressionResidualsPlot(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset,bin_size:float=0.1): +defRegressionResidualsPlot(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset,bin_size:float=0.1) → Tuple\[go.Figure, go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/RougeScore.qmd b/docs/validmind/tests/model_validation/RougeScore.qmd index afd4d8271..054c86354 100644 --- a/docs/validmind/tests/model_validation/RougeScore.qmd +++ b/docs/validmind/tests/model_validation/RougeScore.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('text_classification', 'text_summarization') -defRougeScore(dataset,model,metric='rouge-1'): +defRougeScore(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel,metric:str='rouge-1') → Tuple\[pd.DataFrame, go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/TimeSeriesPredictionWithCI.qmd b/docs/validmind/tests/model_validation/TimeSeriesPredictionWithCI.qmd index ae74963b1..33fbccd3a 100644 --- a/docs/validmind/tests/model_validation/TimeSeriesPredictionWithCI.qmd +++ b/docs/validmind/tests/model_validation/TimeSeriesPredictionWithCI.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression', 'time_series_forecasting') -defTimeSeriesPredictionWithCI(dataset,model,confidence=0.95): +defTimeSeriesPredictionWithCI(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel,confidence:float=0.95) → Tuple\[pd.DataFrame, go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/TimeSeriesPredictionsPlot.qmd b/docs/validmind/tests/model_validation/TimeSeriesPredictionsPlot.qmd index 3e67ebb14..5aecc022d 100644 --- a/docs/validmind/tests/model_validation/TimeSeriesPredictionsPlot.qmd +++ b/docs/validmind/tests/model_validation/TimeSeriesPredictionsPlot.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression', 'time_series_forecasting') -defTimeSeriesPredictionsPlot(dataset,model): +defTimeSeriesPredictionsPlot(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel) → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/TimeSeriesR2SquareBySegments.qmd b/docs/validmind/tests/model_validation/TimeSeriesR2SquareBySegments.qmd index 60b00b3f2..d823c5a45 100644 --- a/docs/validmind/tests/model_validation/TimeSeriesR2SquareBySegments.qmd +++ b/docs/validmind/tests/model_validation/TimeSeriesR2SquareBySegments.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression', 'time_series_forecasting') -defTimeSeriesR2SquareBySegments(dataset,model,segments=None): +defTimeSeriesR2SquareBySegments(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel,segments:Optional\[int\]=None) → Tuple\[pd.DataFrame, go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/TokenDisparity.qmd b/docs/validmind/tests/model_validation/TokenDisparity.qmd index 236ebc7ff..9d4dd3194 100644 --- a/docs/validmind/tests/model_validation/TokenDisparity.qmd +++ b/docs/validmind/tests/model_validation/TokenDisparity.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('text_classification', 'text_summarization') -defTokenDisparity(dataset,model): +defTokenDisparity(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel) → Tuple\[pd.DataFrame, go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/ToxicityScore.qmd b/docs/validmind/tests/model_validation/ToxicityScore.qmd index f9b99c051..683fd150e 100644 --- a/docs/validmind/tests/model_validation/ToxicityScore.qmd +++ b/docs/validmind/tests/model_validation/ToxicityScore.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('text_classification', 'text_summarization') -defToxicityScore(dataset,model): +defToxicityScore(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel) → Tuple\[pd.DataFrame, go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/AdjustedMutualInformation.qmd b/docs/validmind/tests/model_validation/sklearn/AdjustedMutualInformation.qmd index 4ee45faa2..91a910eee 100644 --- a/docs/validmind/tests/model_validation/sklearn/AdjustedMutualInformation.qmd +++ b/docs/validmind/tests/model_validation/sklearn/AdjustedMutualInformation.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('clustering') -defAdjustedMutualInformation(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset): +defAdjustedMutualInformation(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset) → Tuple\[List\[Dict\[str, float\]\], validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/AdjustedRandIndex.qmd b/docs/validmind/tests/model_validation/sklearn/AdjustedRandIndex.qmd index 8785c2860..6c4d0e9a4 100644 --- a/docs/validmind/tests/model_validation/sklearn/AdjustedRandIndex.qmd +++ b/docs/validmind/tests/model_validation/sklearn/AdjustedRandIndex.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('clustering') -defAdjustedRandIndex(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset): +defAdjustedRandIndex(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset) → Tuple\[List\[Dict\[str, float\]\], validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/CalibrationCurve.qmd b/docs/validmind/tests/model_validation/sklearn/CalibrationCurve.qmd index aa7ec86fc..2dd18710a 100644 --- a/docs/validmind/tests/model_validation/sklearn/CalibrationCurve.qmd +++ b/docs/validmind/tests/model_validation/sklearn/CalibrationCurve.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification') -defCalibrationCurve(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset,n_bins:int=10): +defCalibrationCurve(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset,n_bins:int=10) → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/ClassifierPerformance.qmd b/docs/validmind/tests/model_validation/sklearn/ClassifierPerformance.qmd index 5a652ec0d..9b021eb70 100644 --- a/docs/validmind/tests/model_validation/sklearn/ClassifierPerformance.qmd +++ b/docs/validmind/tests/model_validation/sklearn/ClassifierPerformance.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'text_classification') -defClassifierPerformance(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel,average:str='macro'): +defClassifierPerformance(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel,average:str='macro') → Dict\[str, List\[Dict\[str, float\]\]\]: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/ClassifierThresholdOptimization.qmd b/docs/validmind/tests/model_validation/sklearn/ClassifierThresholdOptimization.qmd index fac8d4406..b17dbf87d 100644 --- a/docs/validmind/tests/model_validation/sklearn/ClassifierThresholdOptimization.qmd +++ b/docs/validmind/tests/model_validation/sklearn/ClassifierThresholdOptimization.qmd @@ -77,7 +77,7 @@ The test implements multiple threshold optimization methods: - `dataset`: VMDataset containing features and target - `model`: VMModel containing predictions -- `methods`: List of methods to compare (default: \['youden', 'f1', 'precision_recall'\]) +- `methods`: List of methods to compare (default: ['youden', 'f1', 'precision_recall']) - `target_recall`: Target recall value if using 'target_recall' method **Returns** diff --git a/docs/validmind/tests/model_validation/sklearn/ClusterCosineSimilarity.qmd b/docs/validmind/tests/model_validation/sklearn/ClusterCosineSimilarity.qmd index 79071e15f..d7caf30e0 100644 --- a/docs/validmind/tests/model_validation/sklearn/ClusterCosineSimilarity.qmd +++ b/docs/validmind/tests/model_validation/sklearn/ClusterCosineSimilarity.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('clustering') -defClusterCosineSimilarity(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset): +defClusterCosineSimilarity(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset) → Tuple\[List\[Dict\[str, float\]\], validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/ClusterPerformanceMetrics.qmd b/docs/validmind/tests/model_validation/sklearn/ClusterPerformanceMetrics.qmd index 9557693de..67ac7c6b7 100644 --- a/docs/validmind/tests/model_validation/sklearn/ClusterPerformanceMetrics.qmd +++ b/docs/validmind/tests/model_validation/sklearn/ClusterPerformanceMetrics.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('clustering') -defClusterPerformanceMetrics(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset): +defClusterPerformanceMetrics(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset) → Tuple\[List\[Dict\[str, float\]\], validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/CompletenessScore.qmd b/docs/validmind/tests/model_validation/sklearn/CompletenessScore.qmd index 1b6e3aa20..75a139432 100644 --- a/docs/validmind/tests/model_validation/sklearn/CompletenessScore.qmd +++ b/docs/validmind/tests/model_validation/sklearn/CompletenessScore.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('clustering') -defCompletenessScore(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset): +defCompletenessScore(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset) → Tuple\[List\[Dict\[str, float\]\], validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/ConfusionMatrix.qmd b/docs/validmind/tests/model_validation/sklearn/ConfusionMatrix.qmd index a05a0207d..02c455b12 100644 --- a/docs/validmind/tests/model_validation/sklearn/ConfusionMatrix.qmd +++ b/docs/validmind/tests/model_validation/sklearn/ConfusionMatrix.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'text_classification') -defConfusionMatrix(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel,threshold:float=0.5): +defConfusionMatrix(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel,threshold:float=0.5) → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/FeatureImportance.qmd b/docs/validmind/tests/model_validation/sklearn/FeatureImportance.qmd index 2e5be43a5..e3888ab35 100644 --- a/docs/validmind/tests/model_validation/sklearn/FeatureImportance.qmd +++ b/docs/validmind/tests/model_validation/sklearn/FeatureImportance.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression', 'time_series_forecasting') -defFeatureImportance(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel,num_features:int=3): +defFeatureImportance(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel,num_features:int=3) → Tuple\[pd.DataFrame, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/FowlkesMallowsScore.qmd b/docs/validmind/tests/model_validation/sklearn/FowlkesMallowsScore.qmd index 1b0658b57..a32beb186 100644 --- a/docs/validmind/tests/model_validation/sklearn/FowlkesMallowsScore.qmd +++ b/docs/validmind/tests/model_validation/sklearn/FowlkesMallowsScore.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('clustering') -defFowlkesMallowsScore(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel): +defFowlkesMallowsScore(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel) → Tuple\[List\[Dict\[str, float\]\], validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/HomogeneityScore.qmd b/docs/validmind/tests/model_validation/sklearn/HomogeneityScore.qmd index 92fede7ad..2e1b99658 100644 --- a/docs/validmind/tests/model_validation/sklearn/HomogeneityScore.qmd +++ b/docs/validmind/tests/model_validation/sklearn/HomogeneityScore.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('clustering') -defHomogeneityScore(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel): +defHomogeneityScore(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel) → Tuple\[List\[Dict\[str, float\]\], validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/HyperParametersTuning.qmd b/docs/validmind/tests/model_validation/sklearn/HyperParametersTuning.qmd index 87d7b8819..c9eb89fd6 100644 --- a/docs/validmind/tests/model_validation/sklearn/HyperParametersTuning.qmd +++ b/docs/validmind/tests/model_validation/sklearn/HyperParametersTuning.qmd @@ -14,10 +14,6 @@ toc-expand: 4 ::: {.signature} -@tags('sklearn', 'model_performance') - -@tasks('classification', 'clustering') - defcustom_recall(y_true,y_pred_proba,threshold=0.5): ::: @@ -34,7 +30,7 @@ toc-expand: 4 @tasks('clustering', 'classification') -defHyperParametersTuning(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset,param_grid:dict,scoring:Union\[str, List, Dict\]=None,thresholds:Union\[float, List\[float\]\]=None,fit_params:dict=None): +defHyperParametersTuning(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset,param_grid:dict,scoring:Union\[str, List, Dict\]=None,thresholds:Union\[float, List\[float\]\]=None,fit_params:dict=None) → Tuple\[List\[Dict\[str, float\]\], validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/KMeansClustersOptimization.qmd b/docs/validmind/tests/model_validation/sklearn/KMeansClustersOptimization.qmd index 7f9351fe1..15a0553f0 100644 --- a/docs/validmind/tests/model_validation/sklearn/KMeansClustersOptimization.qmd +++ b/docs/validmind/tests/model_validation/sklearn/KMeansClustersOptimization.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('clustering') -defKMeansClustersOptimization(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset,n_clusters:Union\[List\[int\], None\]=None): +defKMeansClustersOptimization(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset,n_clusters:Optional\[List\[int\]\]=None) → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/MinimumAccuracy.qmd b/docs/validmind/tests/model_validation/sklearn/MinimumAccuracy.qmd index 8cfaf5400..ea8424794 100644 --- a/docs/validmind/tests/model_validation/sklearn/MinimumAccuracy.qmd +++ b/docs/validmind/tests/model_validation/sklearn/MinimumAccuracy.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'text_classification') -defMinimumAccuracy(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel,min_threshold:float=0.7): +defMinimumAccuracy(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel,min_threshold:float=0.7) → Tuple\[List\[Dict\[str, float\]\], bool, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/MinimumF1Score.qmd b/docs/validmind/tests/model_validation/sklearn/MinimumF1Score.qmd index 78de3af74..46ac8af16 100644 --- a/docs/validmind/tests/model_validation/sklearn/MinimumF1Score.qmd +++ b/docs/validmind/tests/model_validation/sklearn/MinimumF1Score.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'text_classification') -defMinimumF1Score(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel,min_threshold:float=0.5): +defMinimumF1Score(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel,min_threshold:float=0.5) → Tuple\[List\[Dict\[str, float\]\], bool, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/MinimumROCAUCScore.qmd b/docs/validmind/tests/model_validation/sklearn/MinimumROCAUCScore.qmd index 3698dd80d..54092f8a1 100644 --- a/docs/validmind/tests/model_validation/sklearn/MinimumROCAUCScore.qmd +++ b/docs/validmind/tests/model_validation/sklearn/MinimumROCAUCScore.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'text_classification') -defMinimumROCAUCScore(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel,min_threshold:float=0.5): +defMinimumROCAUCScore(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel,min_threshold:float=0.5) → Tuple\[List\[Dict\[str, float\]\], bool, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/ModelParameters.qmd b/docs/validmind/tests/model_validation/sklearn/ModelParameters.qmd index 91942186a..7d80a7561 100644 --- a/docs/validmind/tests/model_validation/sklearn/ModelParameters.qmd +++ b/docs/validmind/tests/model_validation/sklearn/ModelParameters.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'regression') -defModelParameters(model,model_params=None): +defModelParameters(model:validmind.vm_models.VMModel,model_params:Optional\[List\[str\]\]=None) → pd.DataFrame: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/ModelsPerformanceComparison.qmd b/docs/validmind/tests/model_validation/sklearn/ModelsPerformanceComparison.qmd index 95ffbc9e5..7519112df 100644 --- a/docs/validmind/tests/model_validation/sklearn/ModelsPerformanceComparison.qmd +++ b/docs/validmind/tests/model_validation/sklearn/ModelsPerformanceComparison.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'text_classification') -defModelsPerformanceComparison(dataset:validmind.vm_models.VMDataset,models:list\[validmind.vm_models.VMModel\]): +defModelsPerformanceComparison(dataset:validmind.vm_models.VMDataset,models:list\[validmind.vm_models.VMModel\]) → Dict\[str, List\[Dict\[str, float\]\]\]: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/OverfitDiagnosis.qmd b/docs/validmind/tests/model_validation/sklearn/OverfitDiagnosis.qmd index 659d21b8e..4fe4b4e12 100644 --- a/docs/validmind/tests/model_validation/sklearn/OverfitDiagnosis.qmd +++ b/docs/validmind/tests/model_validation/sklearn/OverfitDiagnosis.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'regression') -defOverfitDiagnosis(model:validmind.vm_models.VMModel,datasets:List\[validmind.vm_models.VMDataset\],metric:str=None,cut_off_threshold:float=DEFAULT_THRESHOLD): +defOverfitDiagnosis(model:validmind.vm_models.VMModel,datasets:List\[validmind.vm_models.VMDataset\],metric:str=None,cut_off_threshold:float=DEFAULT_THRESHOLD) → Tuple\[Dict\[str, List\[Dict\[str, float\]\]\], go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/PermutationFeatureImportance.qmd b/docs/validmind/tests/model_validation/sklearn/PermutationFeatureImportance.qmd index 8e292cbb1..958e80e57 100644 --- a/docs/validmind/tests/model_validation/sklearn/PermutationFeatureImportance.qmd +++ b/docs/validmind/tests/model_validation/sklearn/PermutationFeatureImportance.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'text_classification') -defPermutationFeatureImportance(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset,fontsize:Union\[int, None\]=None,figure_height:Union\[int, None\]=None): +defPermutationFeatureImportance(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset,fontsize:Optional\[int\]=None,figure_height:Optional\[int\]=None) → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/PopulationStabilityIndex.qmd b/docs/validmind/tests/model_validation/sklearn/PopulationStabilityIndex.qmd index bf276645c..4b24c7974 100644 --- a/docs/validmind/tests/model_validation/sklearn/PopulationStabilityIndex.qmd +++ b/docs/validmind/tests/model_validation/sklearn/PopulationStabilityIndex.qmd @@ -34,7 +34,7 @@ Taken from: https://towardsdatascience.com/checking-model-stability-and-populati @tasks('classification', 'text_classification') -defPopulationStabilityIndex(datasets:List\[validmind.vm_models.VMDataset\],model:validmind.vm_models.VMModel,num_bins:int=10,mode:str='fixed'): +defPopulationStabilityIndex(datasets:List\[validmind.vm_models.VMDataset\],model:validmind.vm_models.VMModel,num_bins:int=10,mode:str='fixed') → Tuple\[Dict\[str, List\[Dict\[str, float\]\]\], go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/PrecisionRecallCurve.qmd b/docs/validmind/tests/model_validation/sklearn/PrecisionRecallCurve.qmd index a7e10a3ba..03ddeffca 100644 --- a/docs/validmind/tests/model_validation/sklearn/PrecisionRecallCurve.qmd +++ b/docs/validmind/tests/model_validation/sklearn/PrecisionRecallCurve.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'text_classification') -defPrecisionRecallCurve(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset): +defPrecisionRecallCurve(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset) → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/ROCCurve.qmd b/docs/validmind/tests/model_validation/sklearn/ROCCurve.qmd index 92060aa54..ee48df500 100644 --- a/docs/validmind/tests/model_validation/sklearn/ROCCurve.qmd +++ b/docs/validmind/tests/model_validation/sklearn/ROCCurve.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'text_classification') -defROCCurve(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset): +defROCCurve(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset) → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/RegressionErrors.qmd b/docs/validmind/tests/model_validation/sklearn/RegressionErrors.qmd index 9f3dd1a77..339cd0708 100644 --- a/docs/validmind/tests/model_validation/sklearn/RegressionErrors.qmd +++ b/docs/validmind/tests/model_validation/sklearn/RegressionErrors.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression', 'classification') -defRegressionErrors(model,dataset): +defRegressionErrors(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset) → Tuple\[pd.DataFrame, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/RegressionErrorsComparison.qmd b/docs/validmind/tests/model_validation/sklearn/RegressionErrorsComparison.qmd index 75818f819..a5ae5849e 100644 --- a/docs/validmind/tests/model_validation/sklearn/RegressionErrorsComparison.qmd +++ b/docs/validmind/tests/model_validation/sklearn/RegressionErrorsComparison.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression', 'time_series_forecasting') -defRegressionErrorsComparison(datasets,models): +defRegressionErrorsComparison(datasets:List\[validmind.vm_models.VMDataset\],models:List\[validmind.vm_models.VMModel\]) → pd.DataFrame: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/RegressionPerformance.qmd b/docs/validmind/tests/model_validation/sklearn/RegressionPerformance.qmd index c2df7cf1f..cc09eab5d 100644 --- a/docs/validmind/tests/model_validation/sklearn/RegressionPerformance.qmd +++ b/docs/validmind/tests/model_validation/sklearn/RegressionPerformance.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression') -defRegressionPerformance(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset): +defRegressionPerformance(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset) → Tuple\[List\[Dict\[str, float\]\], validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/RegressionR2Square.qmd b/docs/validmind/tests/model_validation/sklearn/RegressionR2Square.qmd index 36dd19d9a..a4e2bbb87 100644 --- a/docs/validmind/tests/model_validation/sklearn/RegressionR2Square.qmd +++ b/docs/validmind/tests/model_validation/sklearn/RegressionR2Square.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression') -defRegressionR2Square(dataset,model): +defRegressionR2Square(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel) → Tuple\[pd.DataFrame, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/RegressionR2SquareComparison.qmd b/docs/validmind/tests/model_validation/sklearn/RegressionR2SquareComparison.qmd index 6dd1ab46d..c0891af89 100644 --- a/docs/validmind/tests/model_validation/sklearn/RegressionR2SquareComparison.qmd +++ b/docs/validmind/tests/model_validation/sklearn/RegressionR2SquareComparison.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression', 'time_series_forecasting') -defRegressionR2SquareComparison(datasets,models): +defRegressionR2SquareComparison(datasets:List\[validmind.vm_models.VMDataset\],models:List\[validmind.vm_models.VMModel\]) → pd.DataFrame: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/RobustnessDiagnosis.qmd b/docs/validmind/tests/model_validation/sklearn/RobustnessDiagnosis.qmd index bc848d43d..ee9e00870 100644 --- a/docs/validmind/tests/model_validation/sklearn/RobustnessDiagnosis.qmd +++ b/docs/validmind/tests/model_validation/sklearn/RobustnessDiagnosis.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'regression') -defRobustnessDiagnosis(datasets:List\[validmind.vm_models.VMDataset\],model:validmind.vm_models.VMModel,metric:str=None,scaling_factor_std_dev_list:List\[float\]=DEFAULT_STD_DEV_LIST,performance_decay_threshold:float=DEFAULT_DECAY_THRESHOLD): +defRobustnessDiagnosis(datasets:List\[validmind.vm_models.VMDataset\],model:validmind.vm_models.VMModel,metric:str=None,scaling_factor_std_dev_list:List\[float\]=DEFAULT_STD_DEV_LIST,performance_decay_threshold:float=DEFAULT_DECAY_THRESHOLD) → Tuple\[pd.DataFrame, go.Figure, bool\]: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/ScoreProbabilityAlignment.qmd b/docs/validmind/tests/model_validation/sklearn/ScoreProbabilityAlignment.qmd index b3d5e9938..8adce4377 100644 --- a/docs/validmind/tests/model_validation/sklearn/ScoreProbabilityAlignment.qmd +++ b/docs/validmind/tests/model_validation/sklearn/ScoreProbabilityAlignment.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification') -defScoreProbabilityAlignment(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset,score_column:str='score',n_bins:int=10): +defScoreProbabilityAlignment(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset,score_column:str='score',n_bins:int=10) → Tuple\[pd.DataFrame, go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/SilhouettePlot.qmd b/docs/validmind/tests/model_validation/sklearn/SilhouettePlot.qmd index ebeb63e69..05c49f830 100644 --- a/docs/validmind/tests/model_validation/sklearn/SilhouettePlot.qmd +++ b/docs/validmind/tests/model_validation/sklearn/SilhouettePlot.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('clustering') -defSilhouettePlot(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset): +defSilhouettePlot(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset) → Tuple\[Dict\[str, float\], go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/TrainingTestDegradation.qmd b/docs/validmind/tests/model_validation/sklearn/TrainingTestDegradation.qmd index 11c84b21b..884c52493 100644 --- a/docs/validmind/tests/model_validation/sklearn/TrainingTestDegradation.qmd +++ b/docs/validmind/tests/model_validation/sklearn/TrainingTestDegradation.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'text_classification') -defTrainingTestDegradation(datasets:List\[validmind.vm_models.VMDataset\],model:validmind.vm_models.VMModel,max_threshold:float=0.1): +defTrainingTestDegradation(datasets:List\[validmind.vm_models.VMDataset\],model:validmind.vm_models.VMModel,max_threshold:float=0.1) → Tuple\[List\[Dict\[str, float\]\], bool, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/VMeasure.qmd b/docs/validmind/tests/model_validation/sklearn/VMeasure.qmd index d4ee8dbe4..be7bfea70 100644 --- a/docs/validmind/tests/model_validation/sklearn/VMeasure.qmd +++ b/docs/validmind/tests/model_validation/sklearn/VMeasure.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('clustering') -defVMeasure(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel): +defVMeasure(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel) → Tuple\[List\[Dict\[str, float\]\], validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/sklearn/WeakspotsDiagnosis.qmd b/docs/validmind/tests/model_validation/sklearn/WeakspotsDiagnosis.qmd index 236cefe91..906ccc917 100644 --- a/docs/validmind/tests/model_validation/sklearn/WeakspotsDiagnosis.qmd +++ b/docs/validmind/tests/model_validation/sklearn/WeakspotsDiagnosis.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'text_classification') -defWeakspotsDiagnosis(datasets:List\[validmind.vm_models.VMDataset\],model:validmind.vm_models.VMModel,features_columns:Union\[List\[str\], None\]=None,metrics:Union\[Dict\[str, Callable\], None\]=None,thresholds:Union\[Dict\[str, float\], None\]=None): +defWeakspotsDiagnosis(datasets:List\[validmind.vm_models.VMDataset\],model:validmind.vm_models.VMModel,features_columns:Optional\[List\[str\]\]=None,metrics:Optional\[Dict\[str, Callable\]\]=None,thresholds:Optional\[Dict\[str, float\]\]=None) → Tuple\[pd.DataFrame, go.Figure, bool\]: ::: diff --git a/docs/validmind/tests/model_validation/statsmodels/AutoARIMA.qmd b/docs/validmind/tests/model_validation/statsmodels/AutoARIMA.qmd index 279ea069f..8e055c73a 100644 --- a/docs/validmind/tests/model_validation/statsmodels/AutoARIMA.qmd +++ b/docs/validmind/tests/model_validation/statsmodels/AutoARIMA.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression') -defAutoARIMA(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset): +defAutoARIMA(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset) → List\[Dict\[str, float\]\]: ::: diff --git a/docs/validmind/tests/model_validation/statsmodels/CumulativePredictionProbabilities.qmd b/docs/validmind/tests/model_validation/statsmodels/CumulativePredictionProbabilities.qmd index ab8c922d2..35fa4f666 100644 --- a/docs/validmind/tests/model_validation/statsmodels/CumulativePredictionProbabilities.qmd +++ b/docs/validmind/tests/model_validation/statsmodels/CumulativePredictionProbabilities.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification') -defCumulativePredictionProbabilities(dataset,model,title='Cumulative Probabilities'): +defCumulativePredictionProbabilities(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel,title:str='Cumulative Probabilities') → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/statsmodels/DurbinWatsonTest.qmd b/docs/validmind/tests/model_validation/statsmodels/DurbinWatsonTest.qmd index 9f5138dbf..36a7fc4d1 100644 --- a/docs/validmind/tests/model_validation/statsmodels/DurbinWatsonTest.qmd +++ b/docs/validmind/tests/model_validation/statsmodels/DurbinWatsonTest.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tags('time_series_data', 'forecasting', 'statistical_test', 'statsmodels') -defDurbinWatsonTest(dataset,model,threshold=\[1.5, 2.5\]): +defDurbinWatsonTest(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel,threshold:List\[float\]=\[1.5, 2.5\]) → Tuple\[pd.DataFrame, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/statsmodels/GINITable.qmd b/docs/validmind/tests/model_validation/statsmodels/GINITable.qmd index fefcc4e35..b0ab32ab8 100644 --- a/docs/validmind/tests/model_validation/statsmodels/GINITable.qmd +++ b/docs/validmind/tests/model_validation/statsmodels/GINITable.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification') -defGINITable(dataset,model): +defGINITable(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel) → Tuple\[pd.DataFrame, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/statsmodels/KolmogorovSmirnov.qmd b/docs/validmind/tests/model_validation/statsmodels/KolmogorovSmirnov.qmd index 11f34d86b..5f3ceccca 100644 --- a/docs/validmind/tests/model_validation/statsmodels/KolmogorovSmirnov.qmd +++ b/docs/validmind/tests/model_validation/statsmodels/KolmogorovSmirnov.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'regression') -defKolmogorovSmirnov(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset,dist:str='norm'): +defKolmogorovSmirnov(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset,dist:str='norm') → Tuple\[List\[Dict\[str, float\]\], validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/statsmodels/Lilliefors.qmd b/docs/validmind/tests/model_validation/statsmodels/Lilliefors.qmd index 616c53c52..7ae0e271d 100644 --- a/docs/validmind/tests/model_validation/statsmodels/Lilliefors.qmd +++ b/docs/validmind/tests/model_validation/statsmodels/Lilliefors.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification', 'regression') -defLilliefors(dataset:validmind.vm_models.VMDataset): +defLilliefors(dataset:validmind.vm_models.VMDataset) → List\[Dict\[str, float\]\]: ::: diff --git a/docs/validmind/tests/model_validation/statsmodels/PredictionProbabilitiesHistogram.qmd b/docs/validmind/tests/model_validation/statsmodels/PredictionProbabilitiesHistogram.qmd index cec69295a..82627a62b 100644 --- a/docs/validmind/tests/model_validation/statsmodels/PredictionProbabilitiesHistogram.qmd +++ b/docs/validmind/tests/model_validation/statsmodels/PredictionProbabilitiesHistogram.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification') -defPredictionProbabilitiesHistogram(dataset,model,title='Histogram of Predictive Probabilities'): +defPredictionProbabilitiesHistogram(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel,title:str='Histogram of Predictive Probabilities') → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/statsmodels/RegressionCoeffs.qmd b/docs/validmind/tests/model_validation/statsmodels/RegressionCoeffs.qmd index 999e7c2d1..5e7ee4867 100644 --- a/docs/validmind/tests/model_validation/statsmodels/RegressionCoeffs.qmd +++ b/docs/validmind/tests/model_validation/statsmodels/RegressionCoeffs.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression') -defRegressionCoeffs(model): +defRegressionCoeffs(model:validmind.vm_models.VMModel) → Tuple\[go.Figure, validmind.vm_models.RawData, pd.DataFrame\]: ::: diff --git a/docs/validmind/tests/model_validation/statsmodels/RegressionFeatureSignificance.qmd b/docs/validmind/tests/model_validation/statsmodels/RegressionFeatureSignificance.qmd index 4a9c3653d..4db55ce49 100644 --- a/docs/validmind/tests/model_validation/statsmodels/RegressionFeatureSignificance.qmd +++ b/docs/validmind/tests/model_validation/statsmodels/RegressionFeatureSignificance.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression') -defRegressionFeatureSignificance(model:validmind.vm_models.VMModel,fontsize:int=10,p_threshold:float=0.05): +defRegressionFeatureSignificance(model:validmind.vm_models.VMModel,fontsize:int=10,p_threshold:float=0.05) → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/statsmodels/RegressionModelForecastPlot.qmd b/docs/validmind/tests/model_validation/statsmodels/RegressionModelForecastPlot.qmd index ab3b8a992..e3b8498ee 100644 --- a/docs/validmind/tests/model_validation/statsmodels/RegressionModelForecastPlot.qmd +++ b/docs/validmind/tests/model_validation/statsmodels/RegressionModelForecastPlot.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression') -defRegressionModelForecastPlot(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset,start_date:Union\[str, None\]=None,end_date:Union\[str, None\]=None): +defRegressionModelForecastPlot(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset,start_date:Optional\[str\]=None,end_date:Optional\[str\]=None) → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/statsmodels/RegressionModelForecastPlotLevels.qmd b/docs/validmind/tests/model_validation/statsmodels/RegressionModelForecastPlotLevels.qmd index b5a20af5c..b2bd9d2f3 100644 --- a/docs/validmind/tests/model_validation/statsmodels/RegressionModelForecastPlotLevels.qmd +++ b/docs/validmind/tests/model_validation/statsmodels/RegressionModelForecastPlotLevels.qmd @@ -30,7 +30,7 @@ toc-expand: 4 @tasks('regression') -defRegressionModelForecastPlotLevels(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset): +defRegressionModelForecastPlotLevels(model:validmind.vm_models.VMModel,dataset:validmind.vm_models.VMDataset) → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/statsmodels/RegressionModelSensitivityPlot.qmd b/docs/validmind/tests/model_validation/statsmodels/RegressionModelSensitivityPlot.qmd index f46376133..682551d83 100644 --- a/docs/validmind/tests/model_validation/statsmodels/RegressionModelSensitivityPlot.qmd +++ b/docs/validmind/tests/model_validation/statsmodels/RegressionModelSensitivityPlot.qmd @@ -30,7 +30,7 @@ toc-expand: 4 @tasks('regression') -defRegressionModelSensitivityPlot(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel,shocks:List\[float\]=\[0.1\],transformation:Union\[str, None\]=None): +defRegressionModelSensitivityPlot(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel,shocks:List\[float\]=\[0.1\],transformation:Union\[str, None\]=None) → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/statsmodels/RegressionModelSummary.qmd b/docs/validmind/tests/model_validation/statsmodels/RegressionModelSummary.qmd index 0d6ffd512..552c74513 100644 --- a/docs/validmind/tests/model_validation/statsmodels/RegressionModelSummary.qmd +++ b/docs/validmind/tests/model_validation/statsmodels/RegressionModelSummary.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression') -defRegressionModelSummary(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel): +defRegressionModelSummary(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel) → Tuple\[List\[Dict\[str, float\]\], validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/statsmodels/RegressionPermutationFeatureImportance.qmd b/docs/validmind/tests/model_validation/statsmodels/RegressionPermutationFeatureImportance.qmd index c541a9efe..4148a0bd6 100644 --- a/docs/validmind/tests/model_validation/statsmodels/RegressionPermutationFeatureImportance.qmd +++ b/docs/validmind/tests/model_validation/statsmodels/RegressionPermutationFeatureImportance.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('regression') -defRegressionPermutationFeatureImportance(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel,fontsize:int=12,figure_height:int=500): +defRegressionPermutationFeatureImportance(dataset:validmind.vm_models.VMDataset,model:validmind.vm_models.VMModel,fontsize:int=12,figure_height:int=500) → Tuple\[go.Figure, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/model_validation/statsmodels/ScorecardHistogram.qmd b/docs/validmind/tests/model_validation/statsmodels/ScorecardHistogram.qmd index e0b59fe45..ae1b107b3 100644 --- a/docs/validmind/tests/model_validation/statsmodels/ScorecardHistogram.qmd +++ b/docs/validmind/tests/model_validation/statsmodels/ScorecardHistogram.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('classification') -defScorecardHistogram(dataset,title='Histogram of Scores',score_column='score'): +defScorecardHistogram(dataset:validmind.vm_models.VMDataset,title:str='Histogram of Scores',score_column:str='score') → go.Figure: ::: diff --git a/docs/validmind/tests/prompt_validation/Bias.qmd b/docs/validmind/tests/prompt_validation/Bias.qmd index 432baf87d..d3f03f5fd 100644 --- a/docs/validmind/tests/prompt_validation/Bias.qmd +++ b/docs/validmind/tests/prompt_validation/Bias.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('text_classification', 'text_summarization') -defBias(model,min_threshold=7,judge_llm=None): +defBias(model,min_threshold=7,judge_llm=None) → Tuple\[List\[Dict\[str, Any\]\], bool, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/prompt_validation/Clarity.qmd b/docs/validmind/tests/prompt_validation/Clarity.qmd index b87fbb28e..d2e97f669 100644 --- a/docs/validmind/tests/prompt_validation/Clarity.qmd +++ b/docs/validmind/tests/prompt_validation/Clarity.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('text_classification', 'text_summarization') -defClarity(model,min_threshold=7,judge_llm=None): +defClarity(model,min_threshold=7,judge_llm=None) → Tuple\[List\[Dict\[str, Any\]\], bool, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/prompt_validation/Conciseness.qmd b/docs/validmind/tests/prompt_validation/Conciseness.qmd index 5faa96884..a3bcb9612 100644 --- a/docs/validmind/tests/prompt_validation/Conciseness.qmd +++ b/docs/validmind/tests/prompt_validation/Conciseness.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('text_classification', 'text_summarization') -defConciseness(model,min_threshold=7,judge_llm=None): +defConciseness(model,min_threshold=7,judge_llm=None) → Tuple\[List\[Dict\[str, Any\]\], bool, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/prompt_validation/Delimitation.qmd b/docs/validmind/tests/prompt_validation/Delimitation.qmd index 7fca0a846..4a5e7d392 100644 --- a/docs/validmind/tests/prompt_validation/Delimitation.qmd +++ b/docs/validmind/tests/prompt_validation/Delimitation.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('text_classification', 'text_summarization') -defDelimitation(model,min_threshold=7,judge_llm=None): +defDelimitation(model,min_threshold=7,judge_llm=None) → Tuple\[List\[Dict\[str, Any\]\], bool, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/prompt_validation/NegativeInstruction.qmd b/docs/validmind/tests/prompt_validation/NegativeInstruction.qmd index 27bd4e53f..93fa681f4 100644 --- a/docs/validmind/tests/prompt_validation/NegativeInstruction.qmd +++ b/docs/validmind/tests/prompt_validation/NegativeInstruction.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('text_classification', 'text_summarization') -defNegativeInstruction(model,min_threshold=7,judge_llm=None): +defNegativeInstruction(model,min_threshold=7,judge_llm=None) → Tuple\[List\[Dict\[str, Any\]\], bool, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/prompt_validation/Robustness.qmd b/docs/validmind/tests/prompt_validation/Robustness.qmd index f6fdd3ec4..5205ff695 100644 --- a/docs/validmind/tests/prompt_validation/Robustness.qmd +++ b/docs/validmind/tests/prompt_validation/Robustness.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('text_classification', 'text_summarization') -defRobustness(model,dataset,num_tests=10,judge_llm=None): +defRobustness(model,dataset,num_tests=10,judge_llm=None) → Tuple\[List\[Dict\[str, Any\]\], bool, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/tests/prompt_validation/Specificity.qmd b/docs/validmind/tests/prompt_validation/Specificity.qmd index d1bffe708..e58c59a1a 100644 --- a/docs/validmind/tests/prompt_validation/Specificity.qmd +++ b/docs/validmind/tests/prompt_validation/Specificity.qmd @@ -18,7 +18,7 @@ toc-expand: 4 @tasks('text_classification', 'text_summarization') -defSpecificity(model,min_threshold=7,judge_llm=None): +defSpecificity(model,min_threshold=7,judge_llm=None) → Tuple\[List\[Dict\[str, Any\]\], bool, validmind.vm_models.RawData\]: ::: diff --git a/docs/validmind/version.qmd b/docs/validmind/version.qmd index b7271a80a..714ed3af5 100644 --- a/docs/validmind/version.qmd +++ b/docs/validmind/version.qmd @@ -9,6 +9,6 @@ sidebar: validmind-reference ::: {.signature} -2.8.25 +2.9.5 ::: diff --git a/docs/validmind/vm_models.qmd b/docs/validmind/vm_models.qmd index bc9fd1f72..39ef39ccf 100644 --- a/docs/validmind/vm_models.qmd +++ b/docs/validmind/vm_models.qmd @@ -16,7 +16,7 @@ Models entrypoint ::: {.signature} -R_MODEL_TYPES= \['LogisticRegression', 'LinearRegression', 'XGBClassifier', 'XGBRegressor'\]: +R_MODEL_TYPES= ['LogisticRegression', 'LinearRegression', 'XGBClassifier', 'XGBRegressor']: ::: @@ -150,7 +150,7 @@ Adds an extra column to the dataset without modifying the dataset `features` and ::: {.signature} -defassign_predictions(self,model:validmind.vm_models.VMModel,prediction_column:Optional\[str\]=None,prediction_values:Optional\[List\[Any\]\]=None,probability_column:Optional\[str\]=None,probability_values:Optional\[List\[float\]\]=None,prediction_probabilities:Optional\[List\[float\]\]=None,\*\*kwargs:Dict\[str, Any\]): +defassign_predictions(self,model:validmind.vm_models.VMModel,prediction_column:Optional\[str\]=None,prediction_values:Optional\[Any\]=None,probability_column:Optional\[str\]=None,probability_values:Optional\[Any\]=None,prediction_probabilities:Optional\[Any\]=None,\*\*kwargs:Dict\[str, Any\]): ::: @@ -162,12 +162,41 @@ Assign predictions and probabilities to the dataset. - `model (VMModel)`: The model used to generate the predictions. - `prediction_column (Optional[str])`: The name of the column containing the predictions. -- `prediction_values (Optional[List[Any]])`: The values of the predictions. +- `prediction_values (Optional[Any])`: The values of the predictions. Can be array-like (list, numpy array, pandas Series, etc.). - `probability_column (Optional[str])`: The name of the column containing the probabilities. -- `probability_values (Optional[List[float]])`: The values of the probabilities. -- `prediction_probabilities (Optional[List[float]])`: DEPRECATED: The values of the probabilities. +- `probability_values (Optional[Any])`: The values of the probabilities. Can be array-like (list, numpy array, pandas Series, etc.). +- `prediction_probabilities (Optional[Any])`: DEPRECATED: The values of the probabilities. Use probability_values instead. - `**kwargs`: Additional keyword arguments that will get passed through to the model's `predict` method. +### assign_scores + + + +::: {.signature} + +defassign_scores(self,metrics:Union\[str, List\[str\]\],model:Optional\[validmind.vm_models.VMModel\]=None,\*\*kwargs:Dict\[str, Any\]): + +::: + + + +Assign computed row metric scores to the dataset as new columns. + +This method computes row metrics for the given model and dataset, then adds the computed scores as new columns to the dataset using the naming convention: {model.input_id}\_{metric_name} + +**Arguments** + +- `model (Optional[VMModel])`: Optional model used to compute the scores. If provided and it has a valid `input_id`, that will be used as a prefix for column names. If not provided (or no `input_id`), columns will be created without a prefix. +- `metrics (Union[str, List[str]])`: Single metric ID or list of metric IDs. Can be either: +- Short name (e.g., "BrierScore", "LogLoss") +- Full metric ID (e.g., "validmind.scorer.classification.BrierScore") +- `**kwargs`: Additional parameters passed to the row metrics. + +**Raises** + +- `ValueError`: If metric computation fails. +- `ImportError`: If scorer module cannot be imported. + ### prediction_column @@ -642,7 +671,7 @@ Test result. ::: {.signature} -TestResult(result_id:str=None,name:str='Test Result',result_type:str=None,ref_id:str=None,title:Optional\[str\]=None,doc:Optional\[str\]=None,description:Optional\[Union\[str, validmind.vm_models.DescriptionFuture\]\]=None,metric:Optional\[Union\[int, float\]\]=None,tables:Optional\[List\[validmind.vm_models.ResultTable\]\]=None,raw_data:Optional\[validmind.vm_models.RawData\]=None,figures:Optional\[List\[Figure\]\]=None,passed:Optional\[bool\]=None,params:Optional\[Dict\[str, Any\]\]=None,inputs:Optional\[Dict\[str, Union\[List\[validmind.vm_models.VMInput\], validmind.vm_models.VMInput\]\]\]=None,metadata:Optional\[Dict\[str, Any\]\]=None,\_was_description_generated:bool=False,\_unsafe:bool=False,\_client_config_cache:Optional\[Any\]=None) +TestResult(result_id:str=None,name:str='Test Result',result_type:str=None,ref_id:str=None,title:Optional\[str\]=None,doc:Optional\[str\]=None,description:Optional\[Union\[str, validmind.vm_models.DescriptionFuture\]\]=None,metric:Optional\[Union\[int, float\]\]=None,scorer:Optional\[List\[Union\[int, float\]\]\]=None,tables:Optional\[List\[validmind.vm_models.ResultTable\]\]=None,raw_data:Optional\[validmind.vm_models.RawData\]=None,figures:Optional\[List\[Figure\]\]=None,passed:Optional\[bool\]=None,params:Optional\[Dict\[str, Any\]\]=None,inputs:Optional\[Dict\[str, Union\[List\[validmind.vm_models.VMInput\], validmind.vm_models.VMInput\]\]\]=None,metadata:Optional\[Dict\[str, Any\]\]=None,\_was_description_generated:bool=False,\_unsafe:bool=False,\_client_config_cache:Optional\[Any\]=None,\_is_scorer_result:bool=False) ::: @@ -690,7 +719,7 @@ Add a new table to the result. **Arguments** - `table (Union[ResultTable, pd.DataFrame, List[Dict[str, Any]]])`: The table to add. -- `title (Optional[str])`: The title of the table (can optionally be provided for pd.DataFrame and List\[Dict\[str, Any\]\] tables). +- `title (Optional[str])`: The title of the table (can optionally be provided for pd.DataFrame and List\[Dict[str, Any]\] tables). ### check_result_id_exist @@ -793,6 +822,20 @@ Remove a table from the result by index. Serialize the result for the API. +### set_metric + + + +::: {.signature} + +defset_metric(self,values:Union\[int, float, List\[Union\[int, float\]\]\]): + +::: + + + +Set the metric value. Args: values: The metric values to set. Can be int, float, or List\[Union[int, float]\]. + ### to_widget @@ -838,152 +881,3 @@ Validate the configuration options for logging a test result Get the test name, using custom title if available. - - - -## TestSuite - - - -::: {.signature} - -@dataclass - -classTestSuite: - -::: - - - -Base class for test suites. Test suites are used to define a grouping of tests that can be run as a suite against datasets and models. Test Suites can be defined by inheriting from this base class and defining the list of tests as a class variable. - -Tests can be a flat list of strings or may be nested into sections by using a dict. - -### TestSuite - - - -::: {.signature} - -TestSuite(sections:List\[validmind.vm_models.TestSuiteSection\]=None) - -::: - -### get_default_config - - - -::: {.signature} - -defget_default_config(self) → dict: - -::: - - - -Returns the default configuration for the test suite. - -Each test in a test suite can accept parameters and those parameters can have default values. Both the parameters and their defaults are set in the test class and a config object can be passed to the test suite's run method to override the defaults. This function returns a dictionary containing the parameters and their default values for every test to allow users to view and set values. - -**Returns** - -- A dictionary of test names and their default parameters. - -### get_tests - - - -::: {.signature} - -defget_tests(self) → List\[str\]: - -::: - - - -Get all test suite test objects from all sections. - -### num_tests - - - -::: {.signature} - -defnum_tests(self) → int: - -::: - - - -Returns the total number of tests in the test suite. - - - -## TestSuiteRunner - - - -::: {.signature} - -classTestSuiteRunner: - -::: - - - -Runs a test suite. - -### TestSuiteRunner - - - -::: {.signature} - -TestSuiteRunner(suite:validmind.vm_models.TestSuite,config:dict=None,inputs:dict=None) - -::: - -### log_results - - - -::: {.signature} - -async deflog_results(self): - -::: - - - -Logs the results of the test suite to ValidMind. - -This method will be called after the test suite has been run and all results have been collected. This method will log the results to ValidMind. - -### run - - - -::: {.signature} - -defrun(self,send:bool=True,fail_fast:bool=False): - -::: - - - -Runs the test suite, renders the summary and sends the results to ValidMind. - -**Arguments** - -- `send (bool, optional)`: Whether to send the results to ValidMind. Defaults to True. -- `fail_fast (bool, optional)`: Whether to stop running tests after the first failure. Defaults to False. - -### summarize - - - -::: {.signature} - -defsummarize(self,show_link:bool=True): - -:::