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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC][MINOR] Added step for dev env setup #4555

Merged
merged 2 commits into from
Jul 14, 2021
Merged

[DOC][MINOR] Added step for dev env setup #4555

merged 2 commits into from
Jul 14, 2021

Conversation

vagoston
Copy link
Contributor

Signed-off-by: Vilmos Agoston vilmos.agoston@gmail.com

What changes are proposed in this pull request?

Minor change in setting up the dev env

How is this patch tested?

local tests pass

Release Notes

Is this a user-facing change?

  • [x ] 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/docs: MLflow documentation pages

  • 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

Signed-off-by: Vilmos Agoston <vilmos.agoston@gmail.com>
@github-actions github-actions bot added area/docs Documentation issues rn/none List under Small Changes in Changelogs. labels Jul 13, 2021
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.

@vagoston Thanks for the PR! Left a comment!

CONTRIBUTING.rst Outdated
@@ -149,6 +149,7 @@ If you plan on doing development and testing, you will also need to install the
pip install -r dev-requirements.txt
pip install -r test-requirements.txt
pip install -e .[extras] # installs mlflow from current checkout
pip install -e tests/resources/mlflow-test-plugin # installs an mlflow plugin for tests
Copy link
Member

@harupy harupy Jul 14, 2021

Choose a reason for hiding this comment

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

Suggested change
pip install -e tests/resources/mlflow-test-plugin # installs an mlflow plugin for tests
pip install -e tests/resources/mlflow-test-plugin # installs `mlflow-test-plugin` that is required for running MLflow plugin tests

Can we fix the comment to clarify why we need to install mlflow-test-plugin?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@harupy Cheers. The thing is that this plugin is required for a lot of tests, not just plugin tests, e.g.

def test_create():

I'll clarify the why part in the comment though.

Copy link
Member

@harupy harupy Jul 14, 2021

Choose a reason for hiding this comment

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

@vagoston You're right! Thanks for the update!

Signed-off-by: Vilmos Agoston <vilmos.agoston@gmail.com>
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

@harupy harupy merged commit 5a5b635 into mlflow:master Jul 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Documentation issues rn/none List under Small Changes in Changelogs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants