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

Adding Notebook for RAG Blog #10661

Merged
merged 6 commits into from
Dec 13, 2023
Merged

Adding Notebook for RAG Blog #10661

merged 6 commits into from
Dec 13, 2023

Conversation

AbeOmor
Copy link
Contributor

@AbeOmor AbeOmor commented Dec 8, 2023 •
edited by BenWilson2
Loading

🛠 DevTools 🛠

Open in GitHub Codespaces

Install mlflow from this PR

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

Checkout with GitHub CLI

gh pr checkout 10661

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Add an end to end example notebook for running evaluation on a RAG application

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

@AbeOmor
Adding Notebook for RAG Blog
5b865ff 
Signed-off-by: Abraham Omorogbe <[email protected]>
@github-actions GitHub Actions
Copy link

github-actions bot commented Dec 8, 2023 •
edited
Loading

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

More info

@BenWilson2
Copy link
Member

We'll need to update a few entries in some other files so that this notebook can be rendered as html.

  1. In the file mlflow/docs/source/llms/rag/index.rst, we need to add the notebook on line 15 to the hidden ToC
  2. A new section in that same document (probably at the top before the existing Question Generation for RAG Tutorial section that includes the links to view the notebook and download it)
  3. An entry to the main index.rst landing page with a link to the notebook (as a card).

LMK if you'd prefer me to push those changes to this branch or not.

@AbeOmor
Copy link
Contributor Author

AbeOmor commented Dec 12, 2023

@BenWilson2 can you help me push the changes. Some of the code in Databricks specfic, so it might not need a card in MLflow. The blog will host it

@BenWilson2
incorporate notebook into docs
e8979ab 
Signed-off-by: Ben Wilson <[email protected]>
@BenWilson2
fix imports
fc5bb68 
Signed-off-by: Ben Wilson <[email protected]>
@github-actions github-actions bot added area/docs Documentation issues rn/documentation Mention under Documentation Changes in Changelogs. labels Dec 12, 2023
@BenWilson2
lint
9228fb9 
Signed-off-by: Ben Wilson <[email protected]>
B-Step62
B-Step62 approved these changes Dec 13, 2023
View reviewed changes
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.

Left a few minor comments, otherwise LGTM!

docs/source/llms/rag/notebooks/mlflow-e2e-evaluation.ipynb Outdated
"texts = text_splitter.split_documents(documents)\n",
"\n",
"llm = Databricks(\n",
" endpoint_name=\"test-endpoint-abraham-omor\",\n",
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
" endpoint_name=\"test-endpoint-abraham-omor\",\n",
" endpoint_name=\"<your-endpoint-name>\",\n",

Copy link
Member

Choose a reason for hiding this comment

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

ah good catch. Missed that one!

docs/source/llms/rag/notebooks/mlflow-e2e-evaluation.ipynb Outdated
}
},
"source": [
"## Create an eval dataset (Golden Dataset)"
Copy link
Collaborator

Choose a reason for hiding this comment

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

It would be helpful to have some description on what we evaluate on this dataset (relevance + latency), and why questions only are sufficient for these metrics.

Copy link
Member

Choose a reason for hiding this comment

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

Agreed. I'll add some context to these main sections just so there's something to follow along with.

docs/source/llms/rag/notebooks/mlflow-e2e-evaluation.ipynb
" list_of_documents = loader.load()\n",
" text_splitter = CharacterTextSplitter(chunk_size=chunk_size, chunk_overlap=0)\n",
" docs = text_splitter.split_documents(list_of_documents)\n",
" embedding_function = SentenceTransformerEmbeddings(model_name=\"all-MiniLM-L6-v2\")\n",
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
" embedding_function = SentenceTransformerEmbeddings(model_name=\"all-MiniLM-L6-v2\")\n",
" embedding_function = DatabricksEmbeddings(endpoint=\"databricks-bge-large-en\")\n",

For consistency

Copy link
Member

Choose a reason for hiding this comment

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

Good catch

Copy link
Member

Choose a reason for hiding this comment

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

I left a comment in the cell above (going to push soon) that explains why this is different from above so that users can see the difference in the output results between the different embeddings models.

@BenWilson2
Add explanations
e531539 
Signed-off-by: Ben Wilson <[email protected]>
@BenWilson2 BenWilson2 enabled auto-merge (squash) December 13, 2023 03:18
@BenWilson2 BenWilson2 merged commit 65cfc3c into master Dec 13, 2023
@BenWilson2 BenWilson2 deleted the e2e-eval-notebook-for-blog branch December 13, 2023 03:36
@harupy harupy mentioned this pull request Dec 13, 2023
Merged
44 tasks
harupy pushed a commit that referenced this pull request Dec 14, 2023
@AbeOmor @BenWilson2 @harupy
Adding Notebook for RAG Blog (#10661)
4672fa1 
Signed-off-by: Abraham Omorogbe <[email protected]>
Signed-off-by: Ben Wilson <[email protected]>
Co-authored-by: Ben Wilson <[email protected]>
harupy pushed a commit that referenced this pull request Dec 14, 2023
@AbeOmor @BenWilson2 @harupy
Adding Notebook for RAG Blog (#10661)
4d5cb6c 
Signed-off-by: Abraham Omorogbe <[email protected]>
Signed-off-by: Ben Wilson <[email protected]>
Co-authored-by: Ben Wilson <[email protected]>
harupy pushed a commit that referenced this pull request Dec 14, 2023
@AbeOmor @BenWilson2 @harupy
Adding Notebook for RAG Blog (#10661)
0cd7b26 
Signed-off-by: Abraham Omorogbe <[email protected]>
Signed-off-by: Ben Wilson <[email protected]>
Co-authored-by: Ben Wilson <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BenWilson2 BenWilson2 BenWilson2 left review comments

@B-Step62 B-Step62 B-Step62 approved these changes

Assignees
No one assigned
Labels
area/docs Documentation issues rn/documentation Mention under Documentation Changes in Changelogs.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@AbeOmor @BenWilson2 @B-Step62