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

Improve docs/model_guide.md with skeleton template code + description of utils like Collator and Reorderer #2358

Open
haileyschoelkopf opened this issue Sep 26, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation. feature request A feature that isn't implemented yet.

Comments

@haileyschoelkopf
Copy link
Collaborator

As per title, some of the machinery we use in HFLM around the ordering, batching, and caching of requests is still opaque to most users.

It'd be great if we could expand model_guide.md with:

  • in templates/new_template_model, a filestub containing the rough outline of a fully-featured HF-like local model impl that uses reorderer, collator, partial caching, and so on
  • Content that explains key footguns / common mistakes when writing a new model class (/ a mini FAQ)
  • more description and documentation of what the different request types are and what they do (perhaps turn this into a blogpost we can link out to instead?)
@haileyschoelkopf haileyschoelkopf added documentation Improvements or additions to documentation. feature request A feature that isn't implemented yet. labels Sep 26, 2024
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. feature request A feature that isn't implemented yet.
Projects
None yet
Development

No branches or pull requests

1 participant