search

UKGovernmentBEIS / inspect_ai

Inspect: A framework for large language model evaluations
https://UKGovernmentBEIS.github.io/inspect_ai/
MIT License
400 stars 41 forks source link

Documentation fixes #4

Closed schmatz closed 1 month ago

schmatz commented 2 months ago

This PR contains:

What is the current behavior? (You can also link to an open issue here)

The documentation contains several typos (misspellings, case issues, punctuation) as well as some issues with a few proper names. There is also a broken link that was fixed and one phrasing improvement.

What is the new behavior?

Fixes the identified issues.

Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)

Not to my knowledge. I also ran quarto preview . to make sure everything built without issues.

Other information:

I was reading the docs to start writing an eval with Inspect. It's a well-built framework and I hope to make more substantive contributions later. Thanks for open sourcing it!

aisi-inspect commented 1 month ago

Thank you!!! We don't yet have the process for taking external PRs into this repo worked out (but we are working on it!). Your edits are excellent and we will incorporate them as part of our next sync (development currently occurs on an internal repo and which is then synced frequently to this public repo).

schmatz commented 1 month ago

Sounds good, thanks! I'll close this PR then.