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: Add metrics documentation and add a 'Reference' section #2230

Merged
merged 6 commits into from
Aug 16, 2024

Conversation

Hugoch
Copy link
Member

@Hugoch Hugoch commented Jul 15, 2024

What does this PR do?

Adds metrics description in the /metrics endpoint and in the documentation.

Helps #2227

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline,
    Pull Request section?
  • Was this discussed/approved via a Github issue or the forum? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes? Here are the
    documentation guidelines, and
    here are tips on formatting docstrings.
  • Did you write any new necessary tests?

Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.

@Narsil

@Hugoch Hugoch added the documentation Improvements or additions to documentation label Jul 15, 2024
@Hugoch Hugoch self-assigned this Jul 15, 2024
@Hugoch Hugoch force-pushed the feat/documentation-metrics branch 2 times, most recently from a2dc281 to 50d6467 Compare July 15, 2024 12:49
@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

@Hugoch Hugoch force-pushed the feat/documentation-metrics branch 6 times, most recently from 0a2d185 to 1c6add7 Compare July 16, 2024 09:57
@Hugoch Hugoch marked this pull request as ready for review July 16, 2024 10:57
@Hugoch Hugoch requested a review from Narsil July 16, 2024 10:58
@Narsil Narsil force-pushed the feat/documentation-metrics branch from 1c6add7 to 173e5e6 Compare August 9, 2024 16:09
Narsil
Narsil previously approved these changes Aug 9, 2024
Copy link
Collaborator

@Narsil Narsil left a comment

Choose a reason for hiding this comment

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

LGTM.

Ideally the metrics would be automatically generated through update_docs but it's fine for now.

Copy link
Collaborator

@Narsil Narsil left a comment

Choose a reason for hiding this comment

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

LGTM

@Narsil Narsil merged commit 53729b7 into main Aug 16, 2024
10 checks passed
@Narsil Narsil deleted the feat/documentation-metrics branch August 16, 2024 17:43
yuanwu2017 pushed a commit to yuanwu2017/tgi-gaudi that referenced this pull request Sep 26, 2024
…face#2230)

* doc: Add metrics documentation and add a 'Reference' section

* doc: Add API reference

* doc: Refactor API reference

* fix: Message API link

* Bad rebase

* Moving the docs.

---------

Co-authored-by: Nicolas Patry <patry.nicolas@protonmail.com>
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

Successfully merging this pull request may close these issues.

3 participants