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

[Feature] docs: Improve documentation on how to use EAGLE speculative docoding #3077

Open
2 tasks done
daviddl9 opened this issue Jan 23, 2025 · 5 comments
Open
2 tasks done
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@daviddl9
Copy link

daviddl9 commented Jan 23, 2025

Checklist

Motivation

The recent addition of EAGLE speculative decoding in here is powerful. Thank you for creating and maintaining such a useful tool! The existing codebase gives insufficient examples of how it can be used (e.g for Llama3 models, for example) together with docker compose. It would be great if another file like https://github.com/sgl-project/sglang/blob/main/docker/compose.yaml can be added to illustrate how the feature can be used in docker environments. Thanks for looking into this issue!

@daviddl9 daviddl9 changed the title [Feature] docs: Improve documentation on how to use EAGLE speculative docoding [Feature] docs: Improve documentation on how to use EAGLE speculative docoding with docker-compose.yml Jan 23, 2025
@zhaochenyang20
Copy link
Collaborator

Yeah. First we should have a docs on EAGLE.

@zhaochenyang20 zhaochenyang20 added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jan 23, 2025
@zhaochenyang20 zhaochenyang20 self-assigned this Jan 23, 2025
@simveit
Copy link
Contributor

simveit commented Jan 23, 2025

I can take this @zhaochenyang20

@zhaochenyang20
Copy link
Collaborator

@simveit Hey Simon. Thanks so much. We can work on accuracy tests first. I will let Jin @jhinpan to take this~

@zhaochenyang20 zhaochenyang20 changed the title [Feature] docs: Improve documentation on how to use EAGLE speculative docoding with docker-compose.yml [Feature] docs: Improve documentation on how to use EAGLE speculative docoding Jan 24, 2025
@zhaochenyang20
Copy link
Collaborator

  1. Add docs for eagle first. Append one ipynb in docs/backend/speculative_decoding.ipynb following this docs: update SGLang status SafeAILab/EAGLE#173 and the style should follow https://docs.sglang.ai/backend/structured_outputs.html
  2. Later check what we need to do for the docker compile.

@zhaochenyang20
Copy link
Collaborator

Detailed guidance are here:

https://docs.sglang.ai/references/contribution_guide.html#writing-documentation-running-docs-ci

and set up your enviroments.

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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants