forked from mlflow/mlflow
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: Andrew Chen <andrewmchen@users.noreply.github.com> Co-authored-by: Mani Parkhe <mparkhe@users.noreply.github.com> Co-authored-by: Siddharth Murching <smurching@users.noreply.github.com> Co-authored-by: Stephanie Bodoff <stbof@users.noreply.github.com> Co-authored-by: tomasatdatabricks <tomasatdatabricks@users.noreply.github.com> Co-authored-by: Aaron Davidson <aarondav@users.noreply.github.com> Co-authored-by: Ali Ghodsi <alig@users.noreply.github.com> Co-authored-by: dmatrix <dmatrix@users.noreply.github.com> Co-authored-by: juntai-zheng <juntai-zheng@users.noreply.github.com>
- Loading branch information
Showing
213 changed files
with
41,256 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,100 @@ | ||
Contributing to MLflow | ||
====================== | ||
We welcome community contributions to MLflow. This page describes how to develop/test your changes | ||
to MLflow locally. | ||
|
||
Prerequisites | ||
------------- | ||
|
||
We recommend installing MLflow in its own virtualenv for development, as follows:: | ||
|
||
virtualenv env | ||
source env/bin/activate | ||
pip install -r dev-requirements.txt | ||
pip install -r tox-requirements.txt | ||
pip install -e . | ||
|
||
|
||
``npm`` is required to run the Javascript dev server. | ||
You can verify that ``npm`` is on the PATH by running ``npm -v``, and | ||
`install npm <https://www.npmjs.com/get-npm>`_ if needed. | ||
|
||
Install Node Modules | ||
~~~~~~~~~~~~~~~~~~~~ | ||
Before running the Javascript dev server or building a distributable wheel, install Javascript | ||
dependencies via: | ||
|
||
.. code:: | ||
cd mlflow/server/js | ||
npm install | ||
cd - # return to root repository directory | ||
If modifying dependencies in ``mlflow/server/js/package.json``, run `npm update` within | ||
``mlflow/server/js`` to install the updated dependencies. | ||
|
||
|
||
Launching the Development UI | ||
---------------------------- | ||
We recommend `Running the Javascript Dev Server`_ - otherwise, the tracking frontend will request | ||
files in the ``mlflow/server/js/build`` directory, which is not checked into Git. | ||
Alternatively, you can generate the necessary files in ``mlflow/server/js/build`` as described in | ||
`Building a Distributable Artifact`_. | ||
|
||
|
||
Tests and Lint | ||
-------------- | ||
Please verify that the unit tests & linter pass before submitting a pull request by running: | ||
|
||
.. code:: | ||
pytest | ||
./lint.sh | ||
Running the Javascript Dev Server | ||
--------------------------------- | ||
`Install Node Modules`_, then run the following: | ||
|
||
In one shell: | ||
|
||
.. code:: | ||
mlflow ui | ||
In another shell: | ||
|
||
.. code:: | ||
cd mlflow/server/js | ||
npm start | ||
The MLflow Tracking UI will show runs logged in ``./mlruns`` at `<http://localhost:3000>`_. | ||
|
||
Building a Distributable Artifact | ||
--------------------------------- | ||
`Install Node Modules`_, then run the following: | ||
|
||
Generate JS files in ``mlflow/server/js/build``: | ||
|
||
.. code:: | ||
cd mlflow/server/js | ||
npm run build | ||
Build a pip-installable wheel in ``dist/``: | ||
|
||
.. code:: | ||
cd - | ||
python setup.py bdist_wheel | ||
Writing Docs | ||
------------ | ||
Install the necessary Python dependencies via ``pip install -r dev-requirements.txt``. Then run | ||
|
||
.. code:: | ||
cd docs | ||
make livehtml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
FROM continuumio/miniconda | ||
|
||
RUN pip install numpy pandas flask pygal smalluuid zipstream python-dateutil gitpython scikit-learn | ||
|
||
WORKDIR /app | ||
|
||
ADD . /app |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,209 @@ | ||
Copyright 2018 Databricks Inc. All rights reserved. | ||
|
||
The Software consists of a Work (as defined below) subject to the Apache License Version 2, | ||
but in order to use certain application programming interfaces (each, an "API") within the Software, | ||
the user of the Software ("Licensee") must obtain a license for the use of the API from Databricks, | ||
Inc. ("Databricks"), by creating an account at www.databricks.com and agreeing to either (a) the | ||
Community Edition Terms of Service, (b) the Databricks Terms of Service, or (c) another written | ||
agreement between Licensee and Databricks for the use of the Software. | ||
|
||
Apache License | ||
Version 2.0, January 2004 | ||
http://www.apache.org/licenses/ | ||
|
||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | ||
|
||
1. Definitions. | ||
|
||
"License" shall mean the terms and conditions for use, reproduction, | ||
and distribution as defined by Sections 1 through 9 of this document. | ||
|
||
"Licensor" shall mean the copyright owner or entity authorized by | ||
the copyright owner that is granting the License. | ||
|
||
"Legal Entity" shall mean the union of the acting entity and all | ||
other entities that control, are controlled by, or are under common | ||
control with that entity. For the purposes of this definition, | ||
"control" means (i) the power, direct or indirect, to cause the | ||
direction or management of such entity, whether by contract or | ||
otherwise, or (ii) ownership of fifty percent (50%) or more of the | ||
outstanding shares, or (iii) beneficial ownership of such entity. | ||
|
||
"You" (or "Your") shall mean an individual or Legal Entity | ||
exercising permissions granted by this License. | ||
|
||
"Source" form shall mean the preferred form for making modifications, | ||
including but not limited to software source code, documentation | ||
source, and configuration files. | ||
|
||
"Object" form shall mean any form resulting from mechanical | ||
transformation or translation of a Source form, including but | ||
not limited to compiled object code, generated documentation, | ||
and conversions to other media types. | ||
|
||
"Work" shall mean the work of authorship, whether in Source or | ||
Object form, made available under the License, as indicated by a | ||
copyright notice that is included in or attached to the work | ||
(an example is provided in the Appendix below). | ||
|
||
"Derivative Works" shall mean any work, whether in Source or Object | ||
form, that is based on (or derived from) the Work and for which the | ||
editorial revisions, annotations, elaborations, or other modifications | ||
represent, as a whole, an original work of authorship. For the purposes | ||
of this License, Derivative Works shall not include works that remain | ||
separable from, or merely link (or bind by name) to the interfaces of, | ||
the Work and Derivative Works thereof. | ||
|
||
"Contribution" shall mean any work of authorship, including | ||
the original version of the Work and any modifications or additions | ||
to that Work or Derivative Works thereof, that is intentionally | ||
submitted to Licensor for inclusion in the Work by the copyright owner | ||
or by an individual or Legal Entity authorized to submit on behalf of | ||
the copyright owner. For the purposes of this definition, "submitted" | ||
means any form of electronic, verbal, or written communication sent | ||
to the Licensor or its representatives, including but not limited to | ||
communication on electronic mailing lists, source code control systems, | ||
and issue tracking systems that are managed by, or on behalf of, the | ||
Licensor for the purpose of discussing and improving the Work, but | ||
excluding communication that is conspicuously marked or otherwise | ||
designated in writing by the copyright owner as "Not a Contribution." | ||
|
||
"Contributor" shall mean Licensor and any individual or Legal Entity | ||
on behalf of whom a Contribution has been received by Licensor and | ||
subsequently incorporated within the Work. | ||
|
||
2. Grant of Copyright License. Subject to the terms and conditions of | ||
this License, each Contributor hereby grants to You a perpetual, | ||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
copyright license to reproduce, prepare Derivative Works of, | ||
publicly display, publicly perform, sublicense, and distribute the | ||
Work and such Derivative Works in Source or Object form. | ||
|
||
3. Grant of Patent License. Subject to the terms and conditions of | ||
this License, each Contributor hereby grants to You a perpetual, | ||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
(except as stated in this section) patent license to make, have made, | ||
use, offer to sell, sell, import, and otherwise transfer the Work, | ||
where such license applies only to those patent claims licensable | ||
by such Contributor that are necessarily infringed by their | ||
Contribution(s) alone or by combination of their Contribution(s) | ||
with the Work to which such Contribution(s) was submitted. If You | ||
institute patent litigation against any entity (including a | ||
cross-claim or counterclaim in a lawsuit) alleging that the Work | ||
or a Contribution incorporated within the Work constitutes direct | ||
or contributory patent infringement, then any patent licenses | ||
granted to You under this License for that Work shall terminate | ||
as of the date such litigation is filed. | ||
|
||
4. Redistribution. You may reproduce and distribute copies of the | ||
Work or Derivative Works thereof in any medium, with or without | ||
modifications, and in Source or Object form, provided that You | ||
meet the following conditions: | ||
|
||
(a) You must give any other recipients of the Work or | ||
Derivative Works a copy of this License; and | ||
|
||
(b) You must cause any modified files to carry prominent notices | ||
stating that You changed the files; and | ||
|
||
(c) You must retain, in the Source form of any Derivative Works | ||
that You distribute, all copyright, patent, trademark, and | ||
attribution notices from the Source form of the Work, | ||
excluding those notices that do not pertain to any part of | ||
the Derivative Works; and | ||
|
||
(d) If the Work includes a "NOTICE" text file as part of its | ||
distribution, then any Derivative Works that You distribute must | ||
include a readable copy of the attribution notices contained | ||
within such NOTICE file, excluding those notices that do not | ||
pertain to any part of the Derivative Works, in at least one | ||
of the following places: within a NOTICE text file distributed | ||
as part of the Derivative Works; within the Source form or | ||
documentation, if provided along with the Derivative Works; or, | ||
within a display generated by the Derivative Works, if and | ||
wherever such third-party notices normally appear. The contents | ||
of the NOTICE file are for informational purposes only and | ||
do not modify the License. You may add Your own attribution | ||
notices within Derivative Works that You distribute, alongside | ||
or as an addendum to the NOTICE text from the Work, provided | ||
that such additional attribution notices cannot be construed | ||
as modifying the License. | ||
|
||
You may add Your own copyright statement to Your modifications and | ||
may provide additional or different license terms and conditions | ||
for use, reproduction, or distribution of Your modifications, or | ||
for any such Derivative Works as a whole, provided Your use, | ||
reproduction, and distribution of the Work otherwise complies with | ||
the conditions stated in this License. | ||
|
||
5. Submission of Contributions. Unless You explicitly state otherwise, | ||
any Contribution intentionally submitted for inclusion in the Work | ||
by You to the Licensor shall be under the terms and conditions of | ||
this License, without any additional terms or conditions. | ||
Notwithstanding the above, nothing herein shall supersede or modify | ||
the terms of any separate license agreement you may have executed | ||
with Licensor regarding such Contributions. | ||
|
||
6. Trademarks. This License does not grant permission to use the trade | ||
names, trademarks, service marks, or product names of the Licensor, | ||
except as required for reasonable and customary use in describing the | ||
origin of the Work and reproducing the content of the NOTICE file. | ||
|
||
7. Disclaimer of Warranty. Unless required by applicable law or | ||
agreed to in writing, Licensor provides the Work (and each | ||
Contributor provides its Contributions) on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
implied, including, without limitation, any warranties or conditions | ||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A | ||
PARTICULAR PURPOSE. You are solely responsible for determining the | ||
appropriateness of using or redistributing the Work and assume any | ||
risks associated with Your exercise of permissions under this License. | ||
|
||
8. Limitation of Liability. In no event and under no legal theory, | ||
whether in tort (including negligence), contract, or otherwise, | ||
unless required by applicable law (such as deliberate and grossly | ||
negligent acts) or agreed to in writing, shall any Contributor be | ||
liable to You for damages, including any direct, indirect, special, | ||
incidental, or consequential damages of any character arising as a | ||
result of this License or out of the use or inability to use the | ||
Work (including but not limited to damages for loss of goodwill, | ||
work stoppage, computer failure or malfunction, or any and all | ||
other commercial damages or losses), even if such Contributor | ||
has been advised of the possibility of such damages. | ||
|
||
9. Accepting Warranty or Additional Liability. While redistributing | ||
the Work or Derivative Works thereof, You may choose to offer, | ||
and charge a fee for, acceptance of support, warranty, indemnity, | ||
or other liability obligations and/or rights consistent with this | ||
License. However, in accepting such obligations, You may act only | ||
on Your own behalf and on Your sole responsibility, not on behalf | ||
of any other Contributor, and only if You agree to indemnify, | ||
defend, and hold each Contributor harmless for any liability | ||
incurred by, or claims asserted against, such Contributor by reason | ||
of your accepting any such warranty or additional liability. | ||
|
||
END OF TERMS AND CONDITIONS | ||
APPENDIX: How to apply the Apache License to your work. | ||
|
||
To apply the Apache License to your work, attach the following | ||
boilerplate notice, with the fields enclosed by brackets "[]" | ||
replaced with your own identifying information. (Don't include | ||
the brackets!) The text should be enclosed in the appropriate | ||
comment syntax for the file format. We also recommend that a | ||
file or class name and description of purpose be included on the | ||
same "printed page" as the copyright notice for easier | ||
identification within third-party archives. | ||
|
||
Copyright 2018 Databricks, Inc. | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
================== | ||
MLflow Alpha Release | ||
================== | ||
|
||
.. warning:: | ||
|
||
The current version of MLflow is an alpha. This means that APIs and storage formats | ||
are subject to change! | ||
|
||
Installing | ||
---------- | ||
Install MLflow from PyPi via ``pip install mlflow`` | ||
|
||
MLflow requires ``conda`` to be on the ``PATH`` for the projects feature. | ||
|
||
Documentation | ||
------------- | ||
Official documentation for MLflow can be found at https://mlflow.org/docs/latest/index.html. | ||
|
||
Running a Sample App With the Tracking API | ||
------------------------------------------ | ||
The programs in ``example`` use the MLflow Tracking API. For instance, run:: | ||
|
||
python example/quickstart/test.py | ||
|
||
This program will use MLflow log API, which stores tracking data in ``./mlruns``, which can then | ||
be viewed with the Tracking UI. | ||
|
||
|
||
Launching the Tracking UI | ||
------------------------- | ||
The MLflow Tracking UI will show runs logged in ``./mlruns`` at `<http://localhost:5000>`_. | ||
Start it with:: | ||
|
||
mlflow ui | ||
|
||
|
||
Running a Project from a URI | ||
---------------------------- | ||
The ``mlflow run`` command lets you run a project packaged with a MLproject file from a local path | ||
or a Git URI:: | ||
|
||
mlflow run example/tutorial -P alpha=0.4 | ||
|
||
mlflow run git@github.com:databricks/mlflow-example.git -P alpha=0.4 | ||
|
||
See ``example/tutorial`` for a sample project with an MLproject file. | ||
|
||
|
||
Saving and Serving Models | ||
------------------------- | ||
To illustrate managing models, the ``mlflow.sklearn`` package can log Scikit-learn models as | ||
MLflow artifacts and then load them again for serving. There is an example training application in | ||
``example/quickstart/test_sklearn.py`` that you can run as follows:: | ||
|
||
$ python example/test_sklearn.py | ||
Score: 0.666 | ||
Model saved in run <run-id> | ||
|
||
$ mlflow sklearn serve -r <run-id> model | ||
|
||
$ curl -d '[{"x": 1}, {"x": -1}]' -H 'Content-Type: application/json' -X POST localhost:5000/invocations | ||
|
||
|
||
|
||
|
||
|
||
Contributing | ||
------------ | ||
We happily welcome contributions, please see our `contribution guide <CONTRIBUTING.rst>`_ | ||
for details. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
def pytest_addoption(parser): | ||
parser.addoption('--large', action='store_true', dest="large", | ||
default=False, help="Run tests decorated with 'large' annotation") | ||
|
||
|
||
def pytest_configure(config): | ||
if not config.option.large: | ||
setattr(config.option, 'markexpr', 'not large') |
Oops, something went wrong.