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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

add recall @ k for retriever eval #10144

Merged
merged 36 commits into from
Oct 28, 2023
Merged

add recall @ k for retriever eval #10144

merged 36 commits into from
Oct 28, 2023

Conversation

bbqiu
Copy link
Collaborator

@bbqiu bbqiu commented Oct 25, 2023 •
edited by liangz1
Loading

🛠 DevTools 🛠

Open in GitHub Codespaces

Install mlflow from this PR

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

Checkout with GitHub CLI

gh pr checkout 10144

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

  1. Add recall_at_k
  2. remove "v1"
  3. Add the k value in the metrics name like: precision_at_3
  4. Refactor docs

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/docs: MLflow documentation pages
  • area/examples: Example code
  • area/gateway: AI Gateway service, Gateway client APIs, third-party Gateway integrations
  • 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

@bbqiu
boilerplate
7c3b89d 
Signed-off-by: Bryan Qiu <[email protected]>
@github-actions
Copy link

github-actions bot commented Oct 25, 2023 •
edited
Loading

Documentation preview for b7efcab will be available here when this CircleCI job completes successfully.

More info

@bbqiu
moving to a diff pr
f4d797a 
Signed-off-by: Bryan Qiu <[email protected]>
@bbqiu
temp
d02b4ec 
Signed-off-by: Bryan Qiu <[email protected]>
@bbqiu
fix one test
f6e4068 
Signed-off-by: Bryan Qiu <[email protected]>
@github-actions github-actions bot added the rn/none List under Small Changes in Changelogs. label Oct 26, 2023
bbqiu and others added 3 commits October 26, 2023 02:22
@bbqiu
soem doc changes
b5d8f87 
Signed-off-by: Bryan Qiu <[email protected]>
@bbqiu
better docstring
17cb199 
Signed-off-by: Bryan Qiu <[email protected]>
@liangz1
Merge branch 'master' into retriever-recall
391c80d 
Signed-off-by: Liang Zhang <[email protected]>
liangz1
liangz1 approved these changes Oct 26, 2023
View reviewed changes
Copy link
Collaborator

@liangz1 liangz1 left a comment

Choose a reason for hiding this comment

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

Looks good overall!

prithvikannan
prithvikannan reviewed Oct 26, 2023
View reviewed changes
Copy link
Collaborator

@prithvikannan prithvikannan left a comment

Choose a reason for hiding this comment

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

Overall LGTM, left a couple small comments. @bbqiu do we already have an example checked in for retriever eval? doesn't need to be super fancy -- something in examples/evaluation/ that can run manually would be great.

docs/source/python_api/mlflow.metrics.rst Outdated Show resolved Hide resolved
tests/evaluate/test_default_evaluator.py Outdated Show resolved Hide resolved
@bbqiu
better docstring
898505b 
Signed-off-by: Bryan Qiu <[email protected]>
@bbqiu bbqiu changed the title add recall @ k for retriever eval [WIP] add recall @ k for retriever eval Oct 26, 2023
@bbqiu
fix k
0ab1af9 
Signed-off-by: Bryan Qiu <[email protected]>
@bbqiu
remove v1
8ba4f77 
Signed-off-by: Bryan Qiu <[email protected]>
@bbqiu
super temp
771f963 
Signed-off-by: Bryan Qiu <[email protected]>
@bbqiu
revert
b72d9e5 
Signed-off-by: Bryan Qiu <[email protected]>
@bbqiu
no repeat doc ids in retrieved
ed1c745 
Signed-off-by: Bryan Qiu <[email protected]>
@bbqiu
fix tests
992b4e7 
Signed-off-by: Bryan Qiu <[email protected]>
@bbqiu
docs changes
fca6674 
Signed-off-by: Bryan Qiu <[email protected]>
@bbqiu
change to retriever_k
ad04937 
Signed-off-by: Bryan Qiu <[email protected]>
@bbqiu
Squashed commit of the following:
6d06cbf 
commit 827d31e
Author: Harutaka Kawamura <[email protected]>
Date:   Fri Oct 27 12:17:31 2023 +0900

    Fix lint error on master (mlflow#10181)

    Signed-off-by: harupy <[email protected]>

commit 15e5b94
Author: Daniel Lok <[email protected]>
Date:   Fri Oct 27 10:57:25 2023 +0800

    Add param to enable/disable saving ONNX model as external data (mlflow#10152)

    Signed-off-by: Daniel Lok <[email protected]>

commit a8ef779
Author: Harutaka Kawamura <[email protected]>
Date:   Fri Oct 27 11:34:29 2023 +0900

    Fix lint job condition (mlflow#10179)

    Signed-off-by: harupy <[email protected]>

commit 8c63df6
Author: Prithvi Kannan <[email protected]>
Date:   Thu Oct 26 18:33:02 2023 -0700

    Remove other timeouts (mlflow#10172)

commit f10fbd3
Author: Prithvi Kannan <[email protected]>
Date:   Thu Oct 26 18:30:58 2023 -0700

    Surface openai error (mlflow#10176)

commit d9b8d17
Author: Ann Zhang <[email protected]>
Date:   Thu Oct 26 18:00:35 2023 -0700

    Fix typo (mlflow#10175)

    Signed-off-by: Ann Zhang <[email protected]>

Signed-off-by: Bryan Qiu <[email protected]>
bbqiu and others added 5 commits October 26, 2023 21:18
@bbqiu
fix tests
5710806 
Signed-off-by: Bryan Qiu <[email protected]>
@bbqiu
fix tests
908d187 
Signed-off-by: Bryan Qiu <[email protected]>
@bbqiu
address comments
d96d59d 
Signed-off-by: Bryan Qiu <[email protected]>
@bbqiu
Merge pull request #1 from bbqiu/retriever-change-pandas-hash
b5963d3 
Retriever change pandas hash
@bbqiu
address comments
28b0b39 
Signed-off-by: Bryan Qiu <[email protected]>
liangz1
liangz1 approved these changes Oct 27, 2023
View reviewed changes
Copy link
Collaborator

@liangz1 liangz1 left a comment

Choose a reason for hiding this comment

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

LGTM! Awesome work, @bbqiu !

dbczumar
dbczumar approved these changes Oct 27, 2023
View reviewed changes
Copy link
Collaborator

@dbczumar dbczumar left a comment

Choose a reason for hiding this comment

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

LGTM!

@bbqiu
lint
ace64d7 
Signed-off-by: Bryan Qiu <[email protected]>
@bbqiu
retriever_k back to k
df63ca9 
Signed-off-by: Bryan Qiu <[email protected]>
@bbqiu
revert
1bd9c01 
Signed-off-by: Bryan Qiu <[email protected]>
@bbqiu
fix precision and recall docs`
b7efcab 
Signed-off-by: Bryan Qiu <[email protected]>
@bbqiu bbqiu enabled auto-merge (squash) October 27, 2023 23:52
@bbqiu bbqiu merged commit 48ded6c into mlflow:master Oct 28, 2023
34 checks passed
KonakanchiSwathi pushed a commit to KonakanchiSwathi/mlflow that referenced this pull request Nov 29, 2023
@bbqiu @liangz1 @KonakanchiSwathi
add recall @ k for retriever eval (mlflow#10144)
c728908 
Signed-off-by: Bryan Qiu <[email protected]>
Signed-off-by: Liang Zhang <[email protected]>
Co-authored-by: Liang Zhang <[email protected]>
Signed-off-by: swathi <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@harupy harupy harupy left review comments

@prithvikannan prithvikannan prithvikannan left review comments

@mlflow mlflow mlflow left review comments

@liangz1 liangz1 liangz1 approved these changes

@dbczumar dbczumar dbczumar approved these changes

@sunishsheth2009 sunishsheth2009 Awaiting requested review from sunishsheth2009

Assignees
No one assigned
Labels
rn/none List under Small Changes in Changelogs.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@bbqiu @harupy @liangz1 @dbczumar @prithvikannan