Skip to content

Commit e2ab541

Browse files
Merge pull request #266366 from lgayhardt/raicli0224
RAI CLI update
2 parents 5d57505 + 42e5f1e commit e2ab541

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

articles/machine-learning/how-to-responsible-ai-insights-sdk-cli.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.topic: how-to
99
ms.reviewer: lagayhar
1010
ms.author: mithigpe
1111
author: minthigpen
12-
ms.date: 11/09/2022
12+
ms.date: 03/29/2024
1313
ms.custom: responsible-ml, devx-track-python
1414
---
1515

@@ -45,7 +45,7 @@ In the following sections are specifications of the Responsible AI components an
4545
4646
### Limitations
4747

48-
The current set of components have a number of limitations on their use:
48+
The current set of components have many limitations on their use:
4949

5050
- All models must be registered in Azure Machine Learning in MLflow format with a sklearn (scikit-learn) flavor.
5151
- The models must be loadable in the component environment.
@@ -76,13 +76,15 @@ The constructor component also accepts the following parameters:
7676
| Parameter name | Description | Type |
7777
|---|---|---|
7878
| `title` | Brief description of the dashboard. | String |
79-
| `task_type` | Specifies whether the model is for classification or regression. | String, `classification` or `regression` |
79+
| `task_type` | Specifies whether the model is for classification, regression, or forecasting. | String, `classification`, `regression`, or `forecasting` |
8080
| `target_column_name` | The name of the column in the input datasets, which the model is trying to predict. | String |
8181
| `maximum_rows_for_test_dataset` | The maximum number of rows allowed in the test dataset, for performance reasons. | Integer, defaults to 5,000 |
8282
| `categorical_column_names` | The columns in the datasets, which represent categorical data. | Optional list of strings<sup>1</sup> |
8383
| `classes` | The full list of class labels in the training dataset. | Optional list of strings<sup>1</sup> |
84+
| `feature_metadata`| Specifies additional information the dashboard might need depending on task type. For forecasting, this includes specifying which column is the `datetime` column and which column is the `time_series_id` column. For vision, this might include mean pixel value or location data of an image.| Optional list of strings<sup>1</sup> |
85+
| `use_model_dependency`| Specifies if the model requires a separate docker container to be served in due to conflicting dependencies with the RAI dashboard. For forecasting, this must be enabled. Typically for other scenarios this isn't enabled. | Boolean |
8486

85-
<sup>1</sup> The lists should be supplied as a single JSON-encoded string for `categorical_column_names` and `classes` inputs.
87+
<sup>1</sup> The lists should be supplied as a single JSON-encoded string for `categorical_column_names`, `classes`, `feature_metadata` inputs.
8688

8789
The constructor component has a single output named `rai_insights_dashboard`. This is an empty dashboard, which the individual tool components operate on. All the results are assembled by the `Gather RAI Insights dashboard` component at the end.
8890

0 commit comments

Comments
 (0)