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

Add examples in the docs #54

Open
svilupp opened this issue Nov 19, 2023 · 1 comment
Open

Add examples in the docs #54

svilupp opened this issue Nov 19, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@svilupp
Copy link
Contributor

svilupp commented Nov 19, 2023

It would be excellent to add some examples in the docs.

I suspect it is hard for newcomers to use the various endpoints and also debug the common error. There is a lot of knowledge how we use these endpoints that is not captured anywhere yet.

Ideas:

  • How to call chat endpoint with the new modes (function call/ tools call, json mode, logit bias classifier)
  • HTTP debugging and tips (errors when calling wrong model-endpoint combination, dropped calls, timeouts, async challenges (Pool vs Threads))
  • Common problems (truncated output for vision models, etc)
  • Some practical example to build easy templates with structs?

WDYT? We could probably start small.

@roryl23
Copy link
Collaborator

roryl23 commented Nov 19, 2023

Agreed - I'm going to start drafting something up while adding the new features.

@cpfiffer cpfiffer added the documentation Improvements or additions to documentation label Dec 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants