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

docs: new models.md page #789

Merged
merged 9 commits into from
Aug 29, 2024
Merged

docs: new models.md page #789

merged 9 commits into from
Aug 29, 2024

Conversation

kevinthecheung
Copy link
Contributor

Description here...

Checklist (if applicable):

  • Tested (manually, unit tested, etc.)
  • Changelog updated
  • Docs updated

@kevinthecheung kevinthecheung requested a review from i14h August 15, 2024 23:41
docs/models.md Outdated Show resolved Hide resolved
Copy link
Member

@MichaelDoyle MichaelDoyle left a comment

Choose a reason for hiding this comment

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

Overall really nice. Thanks!

I do worry a bit about how verbose it is, for folks who are looking to get into the code right away and/or see "what can these models actually do for me".

As one example, we dedicate a lot of sentences to explaining "why" models are hosted behind API end points. We probably don't need to do this. A quick sentence about how this is a rapidly evolving field with many model providers with different (frequently changing) APIs would probably be good enough to explain why a common abstraction is needed.

docs/models.md Show resolved Hide resolved
docs/models.md Outdated Show resolved Hide resolved
docs/models.md Outdated Show resolved Hide resolved
@apascal07
Copy link
Collaborator

Overall looks good! Agree with @MichaelDoyle that it's a bit verbose but I think that we should keep it as is and try to have separate "getting started" versions of concept docs.

@kevinthecheung kevinthecheung merged commit cc18c45 into main Aug 29, 2024
4 checks passed
@kevinthecheung kevinthecheung deleted the kc-models branch August 29, 2024 16:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

[Docs] Missing structured output instructions in the generate content docs
4 participants