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

Update docs to reflect new metric structure #145

Merged
merged 4 commits into from
Oct 8, 2024
Merged

Update docs to reflect new metric structure #145

merged 4 commits into from
Oct 8, 2024

Conversation

yosukehigashi
Copy link
Contributor

#138 changed the structure a bit so the docs need to be updated.

Followed https://github.com/citadel-ai/langcheck/blob/main/docs/contributing.md#documentation and ran:

sphinx-apidoc -f --no-toc --separate --module-first -t docs/_templates/ -o docs src/langcheck/ src/langcheck/stats.py src/langcheck/metrics/model_manager

make -C docs clean html

@kennysong
Copy link
Contributor

LGTM! We don't seem to define what "query based" means anywhere. I guess we can add it in a separate PR?

@yosukehigashi
Copy link
Contributor Author

LGTM! We don't seem to define what "query based" means anywhere. I guess we can add it in a separate PR?

Ah I can add it in this one too - is adding a description to the Metric page what you had in mind?

@kennysong
Copy link
Contributor

Yep, and also on the langcheck.metrics page. I highly suggest using this table formatting plugin to format the table properly!

@liwii
Copy link
Contributor

liwii commented Oct 8, 2024

Ping @yosukehigashi ... it's been here for a few months, aren't we gonna merge this?

@yosukehigashi
Copy link
Contributor Author

Oh I forgot about this. I need to make some updates first - I'll do that today!

@kennysong
Copy link
Contributor

LGTM!

@kennysong kennysong merged commit 61a2b8c into main Oct 8, 2024
38 checks passed
@kennysong kennysong deleted the update-docs branch October 8, 2024 08:58
@liwii liwii mentioned this pull request Oct 28, 2024
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.

3 participants