bento2seldon
This project aims to combine the awesome capabilities of BentoML in packaging models with the powerful Seldon Core engine to deploy such models. It also features an optional cache using Redis that can also be used to make the feedback loop easier by using the request ID to get back the original request and response. For now, it was created for internal use and is in alpha state. But it will soon be prepared to be used by everyone.
Installation
pip install -U bento2seldonor install with Poetry
poetry add bento2seldonMakefile usage
Makefile contains many functions for fast assembling and convenient work.
1. Download and remove Poetry
To download and install Poetry run:
make poetry-downloadTo uninstall
make poetry-remove2. Install all dependencies and pre-commit hooks
Install requirements:
make installPre-commit hooks coulb be installed after git init via
make pre-commit-install3. Codestyle
Automatic formatting uses pyupgrade, isort and black.
make codestyle
# or use synonym
make formattingCodestyle checks only, without rewriting files:
make check-codestyleNote:
check-codestyleusesisort,blackanddarglintlibrary
4. Code security
make check-safetyThis command launches Poetry integrity checks as well as identifies security issues with Safety and Bandit.
make check-safety5. Type checks
Run mypy static type checker
make mypy6. Tests
Run pytest
make test7. All linters
Of course there is a command to rule run all linters in one:
make lintthe same as:
make test && make check-codestyle && make mypy && make check-safety8. Cleanup
Delete pycache files
make pycache-removeRemove package build
make build-removeOr to remove pycache, build and docker image run:
make clean-all
π Releases
You can see the list of available releases on the GitHub Releases page.
We follow Semantic Versions specification.
We use Release Drafter. As pull requests are merged, a draft release is kept up-to-date listing the changes, ready to publish when youβre ready. With the categories option, you can categorize pull requests in release notes using labels.
List of labels and corresponding titles
| Label | Title in Releases |
|---|---|
enhancement, feature
|
|
bug, refactoring, bugfix, fix
|
|
build, ci, testing
|
|
breaking |
|
documentation |
|
dependencies |
|
You can update it in release-drafter.yml.
GitHub creates the bug, enhancement, and documentation labels for you. Dependabot creates the dependencies label. Create the remaining labels on the Issues tab of your GitHub repository, when you need them.
Building and releasing your package
Building a new version of the application contains steps:
- Bump the version of your package
poetry version <version>. You can pass the new version explicitly, or a rule such asmajor,minor, orpatch. For more details, refer to the Semantic Versions standard. - Make a commit to GitHub.
- Create a
GitHub release. - And... publish slightly_smiling_face
poetry publish --build
π‘ License
This project is licensed under the terms of the Apache Software License 2.0 license. See LICENSE for more details.
π Citation
@misc{bento2seldon,
author = {fernandocamargoai},
title = {Bento2Seldon: A package to run BentoML models in a Kubernetes cluster with Seldon},
year = {2021},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/fernandocamargoai/bento2seldon}}
}
Credits 
This project was generated with python-package-template
