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

[Doc] Documentation Updates #4

Merged
merged 10 commits into from
Jul 8, 2024
Merged

[Doc] Documentation Updates #4

merged 10 commits into from
Jul 8, 2024

Conversation

anmolagarwalcp810
Copy link
Collaborator

@anmolagarwalcp810 anmolagarwalcp810 commented Jul 8, 2024

Changes made:

  1. Shortened run_benchmark command.
  2. Added plots to capacity search, how to use metron and prefill profiling pages.
  3. Move metrics section to index toctree so that its visible at the top.
  4. Updated figures on visualizing metrics page.
  5. Replaced "Getting Started" with "How to us metron"
  6. Added link to documentation in README with a banner.
  7. Added initial logo for metron on the banner.
  8. Added html_context object to support backlink on ReadTheDocs.
  9. Removed duplicate license inside docs and renamed LICENSE.txt to LICENSE inside main folder.
  10. Changed default values for CLI args inside run_benchmark.py:
    • --should-use-given-dir now defaults to True
    • --should-write-metrics now defaults to False to prevent writing metrics to wandb by default. Helpful for users who may not have setup wandb.
  11. Updated definition of fluidity index with target prefill and decode latencies instead of TTFT/TBT SLOs.
  12. Added fluid-token-generation-rate metric.

@AgrawalAmey AgrawalAmey enabled auto-merge (squash) July 8, 2024 23:37
@AgrawalAmey AgrawalAmey merged commit 5d160db into main Jul 8, 2024
1 check passed
@anmolagarwalcp810 anmolagarwalcp810 deleted the users/anmol/docs branch July 8, 2024 23:38
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.

2 participants