Skip to content

Conversation

@michaelfeil
Copy link
Owner

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

  • Bug fix
  • New feature
  • Documentation update

Checklist

  • I have read the CONTRIBUTING guidelines.
  • My code follows the code style of this project.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • My changes generate no new warnings.
  • I have updated the documentation accordingly.

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.

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md for 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.md with sync/async API examples
  • Renamed client variable from client to i_client across 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

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`"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

syntax: typo in 'lastest', should be 'latest'

@codecov-commenter
Copy link

codecov-commenter commented Nov 12, 2024

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

Attention: Patch coverage is 75.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 79.23%. Comparing base (98dffca) to head (7564d04).

Files with missing lines Patch % Lines
...ity_emb/infinity_emb/inference/loading_strategy.py 75.00% 1 Missing ⚠️

❗ 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.
📢 Have feedback on the report? Share it here.

@michaelfeil michaelfeil merged commit cdbe888 into main Nov 12, 2024
36 checks passed
@michaelfeil michaelfeil deleted the readme-big-update branch November 12, 2024 07:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants