Skip to content

Clarify pip install is for running pre-built evals#1684

Open
AgenticSpark wants to merge 1 commit into
openai:mainfrom
AgenticSpark:agenticspark/clarify-install-docs-1586
Open

Clarify pip install is for running pre-built evals#1684
AgenticSpark wants to merge 1 commit into
openai:mainfrom
AgenticSpark:agenticspark/clarify-install-docs-1586

Conversation

@AgenticSpark

Copy link
Copy Markdown

Fixes #1586.

The README said pip install is for those who don't want to contribute new evals, which a couple of users read as "pip can't run my own evals." Reword it to make the real distinction clear: pip install to run the pre-built evals, git clone + pip install -e to write your own. One-line docs change, README renders fine.

The 'don't want to contribute new evals' wording confused users into thinking pip install can't run custom evals. Reword to distinguish running pre-built evals (pip) from writing your own (git clone + pip install -e). Closes openai#1586.
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.

Improve installation documentation

1 participant