Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use iloc when computing faithfulness metric #11117

Merged
merged 3 commits into from Feb 14, 2024
Merged

Conversation

harupy
Copy link
Member

@harupy harupy commented Feb 14, 2024

馃洜 DevTools 馃洜

Open in GitHub Codespaces

Install mlflow from this PR

pip install git+https://github.com/mlflow/mlflow.git@refs/pull/11117/merge

Checkout with GitHub CLI

gh pr checkout 11117

Related Issues/PRs

Resolve #11108

What changes are proposed in this pull request?

How is this PR tested?

  • Existing unit/integration tests
  • New unit/integration tests
  • Manual tests

Does this PR require documentation update?

  • No. You can skip the rest of this section.
  • Yes. I've updated:
    • Examples
    • API references
    • Instructions

Release Notes

Is this a user-facing change?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release notes for MLflow users.

What component(s), interfaces, languages, and integrations does this PR affect?

Components

  • area/artifacts: Artifact stores and artifact logging
  • area/build: Build and test infrastructure for MLflow
  • area/deployments: MLflow Deployments client APIs, server, and third-party Deployments integrations
  • area/docs: MLflow documentation pages
  • area/examples: Example code
  • area/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registry
  • area/models: MLmodel format, model serialization/deserialization, flavors
  • area/recipes: Recipes, Recipe APIs, Recipe configs, Recipe Templates
  • area/projects: MLproject format, project running backends
  • area/scoring: MLflow Model server, model deployment tools, Spark UDFs
  • area/server-infra: MLflow Tracking server backend
  • area/tracking: Tracking Service, tracking client APIs, autologging

Interface

  • area/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev server
  • area/docker: Docker use across MLflow's components, such as MLflow Projects and MLflow Models
  • area/sqlalchemy: Use of SQLAlchemy in the Tracking Service or Model Registry
  • area/windows: Windows support

Language

  • language/r: R APIs and clients
  • language/java: Java APIs and clients
  • language/new: Proposals for new client languages

Integrations

  • integrations/azure: Azure and Azure ML integrations
  • integrations/sagemaker: SageMaker integrations
  • integrations/databricks: Databricks integrations

How should the PR be classified in the release notes? Choose one:

  • rn/none - No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" section
  • rn/breaking-change - The PR will be mentioned in the "Breaking Changes" section
  • rn/feature - A new user-facing feature worth mentioning in the release notes
  • rn/bug-fix - A user-facing bug fix worth mentioning in the release notes
  • rn/documentation - A user-facing documentation change worth mentioning in the release notes

Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
Copy link

github-actions bot commented Feb 14, 2024

Documentation preview for 83ccbdc will be available when this CircleCI job completes successfully.

More info

@@ -31,7 +31,7 @@ def _format_args_string(grading_context_columns: Optional[List[str]], eval_value
args_dict = {}
for arg in grading_context_columns:
if arg in eval_values:
args_dict[arg] = eval_values[arg][indx]
args_dict[arg] = eval_values[arg].iloc[indx]
Copy link
Member Author

@harupy harupy Feb 14, 2024

Choose a reason for hiding this comment

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

It looks like the existing code assumes that inputs, outputs, and eval_values[arg] have the same indices and throws when they don't.

grading_payloads = []
for indx, (input, output) in enumerate(zip(inputs, outputs)):
try:
arg_string = _format_args_string(grading_context_columns, eval_values, indx)
except Exception as e:
raise MlflowException(
f"Values for grading_context_columns are malformed and cannot be "
f"formatted into a prompt for metric '{name}'.\n"
f"Required columns: {grading_context_columns}\n"
f"Values: {eval_values}\n"
f"Error: {e!r}\n"
f"Please check the following: \n"
"- predictions and targets (if required) are provided correctly\n"
"- grading_context_columns are mapped correctly using the evaluator_config "
"parameter\n"
"- input and output data are formatted correctly."
)
grading_payloads.append(
evaluation_context["eval_prompt"].format(
input=(input if include_input else None),
output=output,
grading_context_columns=arg_string,
)
)

In the new code, they don't have to have the same indices.

Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
@@ -769,6 +769,14 @@ def test_faithfulness_metric():
examples=[mlflow_example],
)

faithfulness_metric.eval_fn(
# Inputs with different indices
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: the error is rather because of index not starting from 0 I guess?

for indx, (input, output) in enumerate(zip(inputs, outputs)):
            try:
                arg_string = _format_args_string(grading_context_columns, eval_values, indx)

The indx always starts from 0 (cuz we do enumerate) and eval_values[0] will raise KeyError if it doesn't have index 0.

Copy link
Member Author

@harupy harupy Feb 14, 2024

Choose a reason for hiding this comment

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

Exactly, reset_index(drop=True) should also work as @ai-learner-00 explained in #11108

Copy link
Collaborator

@B-Step62 B-Step62 Feb 14, 2024

Choose a reason for hiding this comment

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

yup I think the current solution is fine, plz feel free to merge. Just wanted to make sure the ^comment is accurate:)

Copy link
Collaborator

@B-Step62 B-Step62 left a comment

Choose a reason for hiding this comment

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

LGTM!

@harupy harupy requested a review from B-Step62 February 14, 2024 09:44
@harupy harupy merged commit a030e40 into mlflow:master Feb 14, 2024
37 checks passed
@harupy harupy deleted the use-iloc branch February 14, 2024 10:42
annzhang-db pushed a commit to annzhang-db/mlflow that referenced this pull request Feb 14, 2024
Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
sateeshmannar pushed a commit to StateFarmIns/mlflow that referenced this pull request Feb 20, 2024
Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
artjen pushed a commit to artjen/mlflow that referenced this pull request Mar 26, 2024
Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
Signed-off-by: Arthur Jenoudet <arthur.jenoudet@databricks.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rn/none List under Small Changes in Changelogs.
Projects
None yet
2 participants