https://github.com/src-d/modelforge
Python library to share machine learning models easily and reliably.
https://github.com/src-d/modelforge
git machine-learning model registry sharing
Last synced: about 2 months ago
JSON representation
Python library to share machine learning models easily and reliably.
- Host: GitHub
- URL: https://github.com/src-d/modelforge
- Owner: src-d
- License: apache-2.0
- Created: 2017-07-13T11:16:05.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-11-05T15:25:19.000Z (over 5 years ago)
- Last Synced: 2025-05-05T05:05:20.987Z (about 2 months ago)
- Topics: git, machine-learning, model, registry, sharing
- Language: Python
- Homepage:
- Size: 377 KB
- Stars: 18
- Watchers: 8
- Forks: 14
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Modelforge [](https://docs.sourced.tech/modelforge/) [](https://travis-ci.com/src-d/modelforge) [](https://codecov.io/gh/src-d/modelforge) [](https://pypi.python.org/pypi/modelforge)
Modelforge is a foundation for sharing trained machine learning models. It is a set of command line
tools and a Python library. Modelforge maintains model files in a third-party remote storage service
("cloud") using the backend mechanism. Model metadata (download links, names, descriptions, versions,
etc.) resides in a Git repository called the "Index", and documentation is automatically generated
there. Modelforge does no assumptions about the models: they can be of any origin, such as TensorFlow,
scikit-learn, or your custom. The underlying model storage format -
[Advanced Scientific Data Format](https://github.com/spacetelescope/asdf) - can wrap any data
easily and efficiently, but it's the developer's responsibility to convert.
Learn more about:
* [Why?](doc/why.md) - what problem Modelforge tries to solve.
* [Modelforge model](doc/model.md) - what is a model in Modelforge context.
* [Model storage format](doc/model_storage_format.md) - low-level serialization details.
* [Backends](doc/backends.md) - extension system to upload and download models from clouds.
* [Git Index](doc/git_index.md) - how documentation about the models is generated from the structured metadata.
* [Command line tools](doc/cmdline.md) - how to perform typical operations.
* [API](doc/api.md) - Modelforge API for developers.
#### Who uses Modelforge?
* source{d}, in [src-d/ml](https://github.com/src-d/ml) and [src-d/lookout-sdk-ml](https://github.com/src-d/lookout-sdk-ml); the public index is [src-d/models](https://github.com/src-d/models).
## Install
You can run Modelforge through Docker:
```
docker run -it --rm srcd/modelforge --help
```
or install it using the [Python package manager](https://github.com/pypa/pip):
```
pip3 install modelforge
```
## Usage
The project exposes two interfaces: [command line](doc/cmdline.md) and [API](doc/api.md).
## Contributions
Contributions are pretty much welcome! Please follow the [contributions guide](doc/contributing.md)
and the [code of conduct](doc/code_of_conduct.md).
If you wish to make your MLonCode model available in [src-d/models](https://github.com/src-d/models),
please fork that repository and run `modelforge publish` to upload your model on your fork. Then
create a pull request. You should provide read access to the model file for everybody. If you
consider using our Google Cloud Storage bucket, feel free to contact us through GitHub issues.
## License
[Apache 2.0](LICENSE).