Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated readme #810

Merged
merged 12 commits into from
May 20, 2024
Merged

Conversation

nking-1
Copy link
Contributor

@nking-1 nking-1 commented May 9, 2024

Updates the readme with a brief introduction to the project for a general audience. Adds a link to a demo video. The majority of the existing readme has been left unchanged below the new copy.

@codecov-commenter
Copy link

codecov-commenter commented May 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 62.22%. Comparing base (976e251) to head (4a15f83).

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #810      +/-   ##
==========================================
+ Coverage   59.50%   62.22%   +2.72%     
==========================================
  Files          59       59              
  Lines        4334     4334              
==========================================
+ Hits         2579     2697     +118     
+ Misses       1755     1637     -118     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

README.md Outdated
<img width="201" alt="image" src="https://github.com/guidance-ai/guidance/assets/3740613/646e1a7d-0206-419b-8206-1d835c3a0e0a"><br>

### Get high compatibility—execute a single {guidance} program on many backends (Transformers, llama.cpp, VertexAI, OpenAI).
Works with Transformers, llama.cpp, VertexAI, OpenAI. Users can write one guidance program and execute it on many backends. (note that the most powerful control features require endpoint integration, and for now work best with Transformers and llama.cpp).
Copy link
Collaborator

Choose a reason for hiding this comment

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

I would comment that we don't test VertexAI at all right now, and OpenAI is only tested through AzureAI.

@Harsha-Nori
Copy link
Collaborator

@marcotcr @slundberg might have some thoughts

@slundberg slundberg merged commit 01337d1 into guidance-ai:main May 20, 2024
54 checks passed
This pull request was closed.
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.

5 participants