mlflow-mongodb 0.1.0.dev0__tar.gz

mlflow_mongodb-0.1.0.dev0/LICENSE

@@ -0,0 +1,201 @@
+                                 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 [yyyy] [name of copyright owner]
+
+   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.

mlflow_mongodb-0.1.0.dev0/PKG-INFO

@@ -0,0 +1,157 @@
+Metadata-Version: 2.4
+Name: mlflow-mongodb
+Version: 0.1.0.dev0
+Summary: MongoDB model registry store plugin for MLflow
+Home-page: https://github.com/mongodb-developer/mlflow-mongodb
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: anyio!=4.15.0,<5,>=3.6.2
+Requires-Dist: mlflow>=3.1.0
+Requires-Dist: pymongo[srv]<5,>=4.0.0
+Provides-Extra: dev
+Requires-Dist: check-jsonschema==0.37.4; extra == "dev"
+Requires-Dist: pre-commit==4.6.1; extra == "dev"
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: ruff==0.16.0; extra == "dev"
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# MongoDB Backend for MLflow Registered Models
+
+> [WARNING]
+> This project is under active development and has not reached a stable release. APIs, storage
+> formats, and configuration may change at any time without notice. **It is not intended for
+> production use.** See [LICENSE](LICENSE) for the full disclaimer of warranties.
+
+An MLflow plugin that stores registered models, versions, aliases, tags, and related metadata
+in MongoDB. MLflow tracking data, such as experiments and runs, remains in a separate backend
+store.
+
+## Installation
+
+Python 3.10 or newer, MLflow 3.1 or newer, and a MongoDB deployment are required.
+
+```bash
+python -m pip install "mlflow-mongodb>=0.1.0.dev0"
+```
+
+## Running MLflow
+
+The tracking store and registered-model store are configured independently. For example, the
+following configuration keeps experiments and runs in SQLite and stores registered models
+and their versions in MongoDB:
+
+```bash
+export TRACKING_STORE_URI="sqlite:///tracking.db"
+export REGISTRY_STORE_URI="mongodb://localhost:27017/mlflow_registry"
+export MLFLOW_BIND_HOST="127.0.0.1"
+export MLFLOW_BIND_PORT="5000"
+
+mlflow server \
+  --backend-store-uri "${TRACKING_STORE_URI}" \
+  --registry-store-uri "${REGISTRY_STORE_URI}" \
+  --host "${MLFLOW_BIND_HOST}" \
+  --port "${MLFLOW_BIND_PORT}"
+```
+
+Open `http://127.0.0.1:5000` to use the MLflow UI. Clients can connect to the server with:
+
+```bash
+export MLFLOW_TRACKING_URI="http://127.0.0.1:5000"
+```
+
+The MongoDB URI must include the database name; `mlflow_registry` is the database name in
+the example above. Authentication, replica-set, TLS, and other connection options can be
+provided using standard MongoDB URI syntax. For example:
+
+```text
+mongodb://username:password@mongo.example.com:27017/mlflow_registry?authSource=admin
+```
+
+## Documentation
+
+New to MLflow? Start with the [MLflow Tracking Quickstart](https://mlflow.org/docs/latest/ml/getting-started/quickstart/).
+The following guides provide additional context for using this plugin:
+
+- [Model Registry Tutorial](https://mlflow.org/docs/latest/ml/model-registry/tutorial) — register and manage model versions.
+- [Backend Stores](https://mlflow.org/docs/latest/self-hosting/architecture/backend-store/) — understand where MLflow stores tracking data.
+- [Tracking Server Configuration](https://mlflow.org/docs/latest/self-hosting/architecture/tracking-server/) — configure tracking and registry stores independently.
+- [MongoDB Connection Strings](https://www.mongodb.com/docs/manual/reference/connection-string/) — configure authentication, TLS, replica sets, and other URI options.
+
+## Versioning
+
+This project follows [Semantic Versioning](https://semver.org/) (`MAJOR.MINOR.PATCH`), same as
+[MLflow](https://mlflow.org/) itself. It's currently on major version `0`, meaning the API isn't
+yet stable and may change between releases. `main` always carries a `.devN` version (e.g.
+`0.1.0.dev0`) to signal it's unreleased and ahead of the latest published version.
+
+## Contributor setup
+
+For development, clone the repository and install it in editable mode:
+
+```bash
+git clone https://github.com/mongodb-developer/mlflow-mongodb.git
+cd mlflow-mongodb
+
+python -m venv .venv
+source .venv/bin/activate
+python -m pip install -e .
+```
+
+If you downloaded a source archive instead, extract it and run the `venv` and `pip` commands
+from the extracted repository root. The final `.` in `pip install -e .` means “install the
+project in the current directory,” and `-e` keeps the installation linked to that source
+checkout.
+
+Install the development dependencies and Git hooks with:
+
+```bash
+python -m pip install -e ".[dev]"
+pre-commit install --install-hooks
+```
+
+Run all formatting, linting, and repository checks with:
+
+```bash
+pre-commit run --all-files
+```
+
+## Functional tests
+
+The functional tests use a real MongoDB 8.0 or newer server. Install the project in editable
+mode with its development dependencies before running them:
+
+```bash
+python -m pip install -e ".[dev]"
+```
+
+Set `MONGODB_URI` to a dedicated test database. The database name must contain `test` as a
+distinct hyphen- or underscore-separated segment; for example:
+
+```bash
+export MONGODB_URI="mongodb://localhost:27017/mlflow_functional_test"
+python -m pytest tests/functional
+```
+
+Authentication, replica-set, TLS, and other standard MongoDB URI options can be included in
+`MONGODB_URI`. Use a replica set when running tests that exercise MongoDB transactions.
+
+The functional suite deletes documents from its application collections after every test so
+their indexes can be reused. At the end of the test session, it drops the database selected by
+`MONGODB_URI`. Never point `MONGODB_URI` at a database containing data that must be preserved.

mlflow_mongodb-0.1.0.dev0/README.md

@@ -0,0 +1,123 @@
+# MongoDB Backend for MLflow Registered Models
+
+> [WARNING]
+> This project is under active development and has not reached a stable release. APIs, storage
+> formats, and configuration may change at any time without notice. **It is not intended for
+> production use.** See [LICENSE](LICENSE) for the full disclaimer of warranties.
+
+An MLflow plugin that stores registered models, versions, aliases, tags, and related metadata
+in MongoDB. MLflow tracking data, such as experiments and runs, remains in a separate backend
+store.
+
+## Installation
+
+Python 3.10 or newer, MLflow 3.1 or newer, and a MongoDB deployment are required.
+
+```bash
+python -m pip install "mlflow-mongodb>=0.1.0.dev0"
+```
+
+## Running MLflow
+
+The tracking store and registered-model store are configured independently. For example, the
+following configuration keeps experiments and runs in SQLite and stores registered models
+and their versions in MongoDB:
+
+```bash
+export TRACKING_STORE_URI="sqlite:///tracking.db"
+export REGISTRY_STORE_URI="mongodb://localhost:27017/mlflow_registry"
+export MLFLOW_BIND_HOST="127.0.0.1"
+export MLFLOW_BIND_PORT="5000"
+
+mlflow server \
+  --backend-store-uri "${TRACKING_STORE_URI}" \
+  --registry-store-uri "${REGISTRY_STORE_URI}" \
+  --host "${MLFLOW_BIND_HOST}" \
+  --port "${MLFLOW_BIND_PORT}"
+```
+
+Open `http://127.0.0.1:5000` to use the MLflow UI. Clients can connect to the server with:
+
+```bash
+export MLFLOW_TRACKING_URI="http://127.0.0.1:5000"
+```
+
+The MongoDB URI must include the database name; `mlflow_registry` is the database name in
+the example above. Authentication, replica-set, TLS, and other connection options can be
+provided using standard MongoDB URI syntax. For example:
+
+```text
+mongodb://username:password@mongo.example.com:27017/mlflow_registry?authSource=admin
+```
+
+## Documentation
+
+New to MLflow? Start with the [MLflow Tracking Quickstart](https://mlflow.org/docs/latest/ml/getting-started/quickstart/).
+The following guides provide additional context for using this plugin:
+
+- [Model Registry Tutorial](https://mlflow.org/docs/latest/ml/model-registry/tutorial) — register and manage model versions.
+- [Backend Stores](https://mlflow.org/docs/latest/self-hosting/architecture/backend-store/) — understand where MLflow stores tracking data.
+- [Tracking Server Configuration](https://mlflow.org/docs/latest/self-hosting/architecture/tracking-server/) — configure tracking and registry stores independently.
+- [MongoDB Connection Strings](https://www.mongodb.com/docs/manual/reference/connection-string/) — configure authentication, TLS, replica sets, and other URI options.
+
+## Versioning
+
+This project follows [Semantic Versioning](https://semver.org/) (`MAJOR.MINOR.PATCH`), same as
+[MLflow](https://mlflow.org/) itself. It's currently on major version `0`, meaning the API isn't
+yet stable and may change between releases. `main` always carries a `.devN` version (e.g.
+`0.1.0.dev0`) to signal it's unreleased and ahead of the latest published version.
+
+## Contributor setup
+
+For development, clone the repository and install it in editable mode:
+
+```bash
+git clone https://github.com/mongodb-developer/mlflow-mongodb.git
+cd mlflow-mongodb
+
+python -m venv .venv
+source .venv/bin/activate
+python -m pip install -e .
+```
+
+If you downloaded a source archive instead, extract it and run the `venv` and `pip` commands
+from the extracted repository root. The final `.` in `pip install -e .` means “install the
+project in the current directory,” and `-e` keeps the installation linked to that source
+checkout.
+
+Install the development dependencies and Git hooks with:
+
+```bash
+python -m pip install -e ".[dev]"
+pre-commit install --install-hooks
+```
+
+Run all formatting, linting, and repository checks with:
+
+```bash
+pre-commit run --all-files
+```
+
+## Functional tests
+
+The functional tests use a real MongoDB 8.0 or newer server. Install the project in editable
+mode with its development dependencies before running them:
+
+```bash
+python -m pip install -e ".[dev]"
+```
+
+Set `MONGODB_URI` to a dedicated test database. The database name must contain `test` as a
+distinct hyphen- or underscore-separated segment; for example:
+
+```bash
+export MONGODB_URI="mongodb://localhost:27017/mlflow_functional_test"
+python -m pytest tests/functional
+```
+
+Authentication, replica-set, TLS, and other standard MongoDB URI options can be included in
+`MONGODB_URI`. Use a replica set when running tests that exercise MongoDB transactions.
+
+The functional suite deletes documents from its application collections after every test so
+their indexes can be reused. At the end of the test session, it drops the database selected by
+`MONGODB_URI`. Never point `MONGODB_URI` at a database containing data that must be preserved.

mlflow_mongodb-0.1.0.dev0/mlflow_mongodb/__init__.py

@@ -0,0 +1,6 @@
+"""MongoDB model registry store plugin for MLflow."""
+
+from mlflow_mongodb.model_registry_store import MongoDBModelRegistryStore
+
+__all__ = ["MongoDBModelRegistryStore"]
+__version__ = "0.1.0.dev0"