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

Docs for prompt engineering UI #9568

Merged
merged 6 commits into from
Sep 12, 2023
Merged

Docs for prompt engineering UI #9568

merged 6 commits into from
Sep 12, 2023

Conversation

dbczumar
Copy link
Collaborator

@dbczumar dbczumar commented Sep 8, 2023

What changes are proposed in this pull request?

Docs for prompt engineering UI

How is this patch tested?

  • Existing unit/integration tests
  • New unit/integration tests
  • Manual tests (describe details, including test results, below)

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.

(Details in 1-2 sentences. You can just refer to another PR with a description if this PR is part of a larger change.)

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/breaking-change - The PR will be mentioned in the "Breaking Changes" section
  • 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/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

@dbczumar dbczumar closed this Sep 8, 2023
Files
d14ca48 
Signed-off-by: Corey Zumar <corey.zumar@mgcw6f7y3m.corp.databricks.com>
@dbczumar dbczumar reopened this Sep 8, 2023
Add missing image
f1b95f8 
Signed-off-by: Corey Zumar <corey.zumar@mgcw6f7y3m.corp.databricks.com>
@github-actions
Copy link

github-actions bot commented Sep 8, 2023

@dbczumar Thank you for the contribution! Could you fix the following issue(s)?

⚠ DCO check

The DCO check failed. Please sign off your commit(s) by following the instructions here. See https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.md#sign-your-work for more details.

@github-actions github-actions bot added area/docs Documentation issues rn/none List under Small Changes in Changelogs. labels Sep 8, 2023
@github-actions
Copy link

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

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

More info

BenWilson2
BenWilson2 approved these changes Sep 8, 2023
View reviewed changes
Copy link
Member

@BenWilson2 BenWilson2 left a comment

Choose a reason for hiding this comment

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

LGTM!

@BenWilson2
Copy link
Member

@mlflow-automation autoformat

harupy
harupy reviewed Sep 8, 2023
View reviewed changes
docs/source/llms/prompt-engineering.rst
Comment on lines +61 to +65
.. |new_run| image:: ../_static/images/new_run.png
:width: 25%

.. |prompt_modal_1| image:: ../_static/images/prompt_modal_1.png
:width: 70%
Copy link
Member

@harupy harupy Sep 8, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

This part looks like this. The images are stacked horizontally. Is this intended?

image

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, let me know if you have suggestions for improvements

Copy link
Member

@harupy harupy Sep 9, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

GIF? To me this looks like one screenshot.

Copy link
Member

@harupy harupy Sep 9, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

or a screenshot like this as new_run.png?

image

so they don't look like one image.

harupy
harupy reviewed Sep 8, 2023
View reviewed changes
docs/source/llms/prompt-engineering.rst
Comment on lines +150 to +154
.. |add_row| image:: ../_static/images/add_row.png
:width: 10%

.. |add_row_modal| image:: ../_static/images/add_row_modal.png
:width: 50%
Copy link
Member

Choose a reason for hiding this comment

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

This part looks like this. Is this intended?

image

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, let me know if you have suggestions for improvements

prithvikannan
prithvikannan approved these changes Sep 8, 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.

LGTM overall, couple small things

docs/source/llms/prompt-engineering.rst Outdated
Step 1: Create an AI Gateway Completions Route
----------------------------------------------
To use the prompt engineering UI, you need to create one or more :ref:`AI Gateway <gateway>`
completions :ref:`Routes <routes>`. Follow the
Copy link
Collaborator

Choose a reason for hiding this comment

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

we support chat routes now too

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Great catch - fixed!

docs/source/llms/prompt-engineering.rst Outdated
Comment on lines 76 to 80
and *max_tokens* (currently empty). The LLM response will appear in the *Output* section.

.. figure:: ../_static/images/prompt_modal_2.png
:scale: 25%
:align: center
Copy link
Collaborator

Choose a reason for hiding this comment

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

this image has max_tokens of 1000. can we update the text?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Great catch - fixed!

Address review comments
8767fa9 
Signed-off-by: Corey Zumar <corey.zumar@mgcw6f7y3m.corp.databricks.com>
dbczumar
dbczumar commented Sep 8, 2023
View reviewed changes
Copy link
Collaborator Author

@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.

@prithvikannan @harupy thanks for the excellent feedback. Addressed your comments! :)

docs/source/llms/prompt-engineering.rst Outdated
Step 1: Create an AI Gateway Completions Route
----------------------------------------------
To use the prompt engineering UI, you need to create one or more :ref:`AI Gateway <gateway>`
completions :ref:`Routes <routes>`. Follow the
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Great catch - fixed!

docs/source/llms/prompt-engineering.rst Outdated Show resolved Hide resolved
docs/source/llms/prompt-engineering.rst
Comment on lines +61 to +65
.. |new_run| image:: ../_static/images/new_run.png
:width: 25%

.. |prompt_modal_1| image:: ../_static/images/prompt_modal_1.png
:width: 70%
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, let me know if you have suggestions for improvements

docs/source/llms/prompt-engineering.rst Outdated
Comment on lines 76 to 80
and *max_tokens* (currently empty). The LLM response will appear in the *Output* section.

.. figure:: ../_static/images/prompt_modal_2.png
:scale: 25%
:align: center
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Great catch - fixed!

docs/source/llms/prompt-engineering.rst Outdated Show resolved Hide resolved
docs/source/llms/prompt-engineering.rst
Comment on lines +150 to +154
.. |add_row| image:: ../_static/images/add_row.png
:width: 10%

.. |add_row_modal| image:: ../_static/images/add_row_modal.png
:width: 50%
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, let me know if you have suggestions for improvements

docs/source/llms/prompt-engineering.rst Outdated Show resolved Hide resolved
harupy
harupy approved these changes Sep 9, 2023
View reviewed changes
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.

Left a few more comments, otherwise LGTM!

dbczumar and others added 3 commits September 11, 2023 17:30
@dbczumar @harupy
Update docs/source/llms/prompt-engineering.rst
490932e 
Co-authored-by: Harutaka Kawamura <hkawamura0130@gmail.com>
Signed-off-by: Corey Zumar <39497902+dbczumar@users.noreply.github.com>
@dbczumar @harupy
Update docs/source/llms/prompt-engineering.rst
d047154 
Co-authored-by: Harutaka Kawamura <hkawamura0130@gmail.com>
Signed-off-by: Corey Zumar <39497902+dbczumar@users.noreply.github.com>
Lint
de37ed8 
Signed-off-by: Corey Zumar <corey.zumar@mgcw6f7y3m.corp.databricks.com>
@dbczumar dbczumar merged commit ccb68b0 into mlflow:master Sep 12, 2023
20 of 25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@prithvikannan prithvikannan prithvikannan approved these changes

@BenWilson2 BenWilson2 BenWilson2 approved these changes

@harupy harupy harupy approved these changes

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

Successfully merging this pull request may close these issues.
4 participants
@dbczumar @BenWilson2 @harupy @prithvikannan