Readme and Doc update #459
Conversation
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Summary
This PR significantly updates documentation and templates across the project, focusing on improved clarity, organization, and user experience.
- Added specialized Docker image documentation in
README.mdfor CPU, ROCm, and ONNX-GPU/TensorRT deployments - Streamlined issue templates in
.github/ISSUE_TEMPLATE/for better bug reporting and model addition workflows - Added comprehensive client documentation in
docs/docs/client_infinity.mdwith sync/async API examples - Renamed client variable from
clienttoi_clientacross all code examples for better clarity - Updated build scripts to properly handle OpenAPI client generation and testing separately
9 file(s) reviewed, 12 comment(s)
Edit PR Review Bot Settings | Greptile
| description: | | ||
| Please note that if the model implementation isn't available in `transformers`, the model can't be loaded. | ||
| Please note that if the model implementation isn't available in huggingface libaries (`transformers`), the model can't be loaded. | ||
| options: | ||
| - label: "The model implementation is available on transformers" | ||
| - label: "The model weights are available on huggingface-hub" | ||
| - label: "I verified that the model is currently not running in the lastest version `pip install infinity_emb[all] --upgrade`" |
There was a problem hiding this comment.
syntax: typo in 'lastest', should be 'latest'
|
Codecov ReportAttention: Patch coverage is
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## main #459 +/- ##
==========================================
+ Coverage 79.19% 79.23% +0.03%
==========================================
Files 42 42
Lines 3379 3380 +1
==========================================
+ Hits 2676 2678 +2
+ Misses 703 702 -1 ☔ View full report in Codecov by Sentry. |
Description
Please provide a clear and concise description of the changes in this PR.
Related Issue
If applicable, link the issue this PR addresses.
Types of Change
Checklist
Additional Notes
Add any other context about the PR here.
License
By submitting this PR, I confirm that my contribution is made under the terms of the MIT license.