-
Notifications
You must be signed in to change notification settings - Fork 4k
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
Re-organize requirements files #5073
Conversation
Signed-off-by: harupy <hkawamura0130@gmail.com>
Signed-off-by: harupy <hkawamura0130@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. I agree with this re-org of the files. Because putting the requirements files under dev
could confuse the developer to think that dev
directory is used for setting up the personal development environment (which is actually used for github workflows).
Only one non-blocking comment about the wording.
@@ -147,8 +147,7 @@ If you plan on doing development and testing, you will also need to install the | |||
|
|||
.. code-block:: bash | |||
|
|||
pip install -r doc-requirements.txt | |||
pip install -r test-requirements.txt | |||
pip install -r requirements/test-requirements.txt |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually, I find the ordering here a bit annoying. When I read this doc, I follow the order to install ip install -e .[extras]
first (in the previous paragraph). After that, I read If you plan on doing development and testing, you will also need to install the following into the conda environment
, where it asks you to install requirements/test-requirements.txt
first and then extras
. The result is, many libs are installed, uninstalled, and reinstalled back and forth (since some requirements have version limitations while others don't).
It would be convenient if you rephrase it to avoid developers installing pip install -e .[extras]
first or make the requirements compatible (installing test-requirements.txt
should not need to uninstall libs from extras
).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@liangz1 Good point. Can we merge these code two blocks into one?
conda create --name mlflow-dev-env python=3.6
conda activate mlflow-dev-env
# installs mlflow from current checkout with packages required for development
pip install -e .[extras] -r requirements/test-requirements.txt
pip install -e tests/resources/mlflow-test-plugin
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure whether this will resolve the difficulty, since the audience might still install [extras]
first and then have to uninstall the dependencies that do not meet requirements/test-requirements.txt
.
Anyways, it just takes a longer time but is correct, so we don't have to spend too much time on it.
requirements
directorySigned-off-by: harupy <hkawamura0130@gmail.com>
Signed-off-by: harupy hkawamura0130@gmail.com
What changes are proposed in this pull request?
Re-organize requirements files to improve the file structure in the repository.
How is this patch tested?
NA
Does this PR change the documentation?
ci/circleci: build_doc
check. If it's successful, proceed to thenext step, otherwise fix it.
Details
on the right to open the job page of CircleCI.Artifacts
tab.docs/build/html/index.html
.Release Notes
Is this a user-facing change?
(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 loggingarea/build
: Build and test infrastructure for MLflowarea/docs
: MLflow documentation pagesarea/examples
: Example codearea/model-registry
: Model Registry service, APIs, and the fluent client calls for Model Registryarea/models
: MLmodel format, model serialization/deserialization, flavorsarea/projects
: MLproject format, project running backendsarea/scoring
: MLflow Model server, model deployment tools, Spark UDFsarea/server-infra
: MLflow Tracking server backendarea/tracking
: Tracking Service, tracking client APIs, autologgingInterface
area/uiux
: Front-end, user experience, plotting, JavaScript, JavaScript dev serverarea/docker
: Docker use across MLflow's components, such as MLflow Projects and MLflow Modelsarea/sqlalchemy
: Use of SQLAlchemy in the Tracking Service or Model Registryarea/windows
: Windows supportLanguage
language/r
: R APIs and clientslanguage/java
: Java APIs and clientslanguage/new
: Proposals for new client languagesIntegrations
integrations/azure
: Azure and Azure ML integrationsintegrations/sagemaker
: SageMaker integrationsintegrations/databricks
: Databricks integrationsHow should the PR be classified in the release notes? Choose one:
rn/breaking-change
- The PR will be mentioned in the "Breaking Changes" sectionrn/none
- No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" sectionrn/feature
- A new user-facing feature worth mentioning in the release notesrn/bug-fix
- A user-facing bug fix worth mentioning in the release notesrn/documentation
- A user-facing documentation change worth mentioning in the release notes