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

Add tutorial notebook for PEFT #11216

Merged
merged 4 commits into from Feb 23, 2024
Merged

Add tutorial notebook for PEFT #11216

merged 4 commits into from Feb 23, 2024

Conversation

B-Step62
Copy link
Collaborator

@B-Step62 B-Step62 commented Feb 21, 2024

馃洜 DevTools 馃洜

Open in GitHub Codespaces

Install mlflow from this PR

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

Checkout with GitHub CLI

gh pr checkout 11216

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Add a tutorial notebook for PEFT (QLoRA) with MLflow. The main docs will be updated in a separate PR.

Note: It seems the new linter confuses the shell script cell with Python.

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: B-Step62 <yuki.watanabe@databricks.com>
Copy link

github-actions bot commented Feb 21, 2024

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

More info

@github-actions github-actions bot added area/docs Documentation issues rn/documentation Mention under Documentation Changes in Changelogs. labels Feb 21, 2024
Signed-off-by: B-Step62 <yuki.watanabe@databricks.com>
@B-Step62 B-Step62 changed the title [WIP] Add tutorial notebook for PEFT Add tutorial notebook for PEFT Feb 22, 2024
Copy link
Member

@harupy harupy left a comment

Choose a reason for hiding this comment

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

LGTM!

Signed-off-by: B-Step62 <yuki.watanabe@databricks.com>
"cell_type": "raw",
"metadata": {},
"source": [
"<p></p>\n",
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Found that we can insert the download link in the notebook using "raw" cell, so we can remove the workaround of putting the button in index page. If this sounds good, I will apply same to the other Transformers notebook in the follow-up cc: @BenWilson2

Copy link
Member

Choose a reason for hiding this comment

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

The original reason for not putting the download link in the notebook itself was purely so that users wouldn't be confused with a download button embedded in their local copy of the notebook and, if they clicked on it, having a bunch of stateless copies of the notebook fill up their downloads folder.
That might be a bit overkill as a cautionary confusion prevention step, though. I'm fine with embedding it :)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Ooh sorry didn't remember that was the reason but just thought it was nbsphinx thing...
Let me stick to embedded button here for simplify the top page (as Transformers now have more notebooks so it might be a bit hard to find the corresponding link from the list), but keep the other flavors pages as they are.

Copy link
Member

Choose a reason for hiding this comment

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

No, I agree with you. Let's file a ticket for next sprint to migrate to the raw embed within notebook approach. It's cleaner. We should do this for all notebooks in all sections. Probably a 0.5 point ticket :)

}
],
"source": [
"% nvidia-smi"
Copy link
Member

Choose a reason for hiding this comment

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

Does Jupyter support this magic command?

Copy link
Member

@harupy harupy Feb 22, 2024

Choose a reason for hiding this comment

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

What happens if I run-all this notebook and nvidia-smi is not installed?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Does Jupyter support this magic command?

Nope, fixed to %sh nvidia-smi.

What happens if I run-all this notebook and nvidia-smi is not installed?

The first cell should fail with command not found, which is desired as we don't expect users to run this notebook without CUDA GPU backend.

Signed-off-by: B-Step62 <yuki.watanabe@databricks.com>
@B-Step62 B-Step62 merged commit 30083c0 into mlflow:peft Feb 23, 2024
37 checks passed
@B-Step62 B-Step62 deleted the peft-notebook branch February 23, 2024 14:35
B-Step62 added a commit that referenced this pull request Feb 23, 2024
Signed-off-by: B-Step62 <yuki.watanabe@databricks.com>
B-Step62 added a commit to B-Step62/mlflow that referenced this pull request Feb 26, 2024
Signed-off-by: B-Step62 <yuki.watanabe@databricks.com>
B-Step62 added a commit that referenced this pull request Feb 27, 2024
Signed-off-by: B-Step62 <yuki.watanabe@databricks.com>
B-Step62 added a commit that referenced this pull request Feb 28, 2024
Signed-off-by: B-Step62 <yuki.watanabe@databricks.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Documentation issues rn/documentation Mention under Documentation Changes in Changelogs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants