bentoml / bentoctl

Fast model deployment on any cloud 🚀
https://bentoml.com
Other
175 stars 30 forks source link

docs: revamp docs #171

Closed jjmachan closed 2 years ago

jjmachan commented 2 years ago

Description

Add documentation for bentoctl. Added more info about philosophy, use of terraform and supported deployments. closes:

codecov[bot] commented 2 years ago

Codecov Report

Merging #171 (900677b) into main (180d38e) will decrease coverage by 1.39%. The diff coverage is n/a.

:exclamation: Current head 900677b differs from pull request most recent head 509177d. Consider uploading reports for the commit 509177d to get more accurate results

@@            Coverage Diff             @@
##             main     #171      +/-   ##
==========================================
- Coverage   60.27%   58.87%   -1.40%     
==========================================
  Files          24       24              
  Lines        1110     1138      +28     
==========================================
+ Hits          669      670       +1     
- Misses        441      468      +27     
Flag Coverage Δ
unit-tests 58.87% <ø> (-1.40%) :arrow_down:

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
bentoctl/utils/usage_stats.py 78.26% <0.00%> (-16.74%) :arrow_down:
bentoctl/cli/utils.py 61.76% <0.00%> (-11.77%) :arrow_down:
bentoctl/cli/__init__.py 82.75% <0.00%> (-2.30%) :arrow_down:
bentoctl/operator/registry.py 58.26% <0.00%> (-1.91%) :arrow_down:
bentoctl/docker_utils.py 24.65% <0.00%> (-0.70%) :arrow_down:
bentoctl/cli/operator_management.py 42.16% <0.00%> (+2.97%) :arrow_up:

:mega: Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

jjmachan commented 2 years ago

more doc ideas

  1. debugging guide explaining how to use --debug flag for issues related to build and intermediate bentos

Sagemaker

  1. give an architecture diagram
  2. option to deploy without lambda and API gateway services. They can invoke it directly which improves the latency, cost and has no timeout