🤖 Fix #51: docs: write 'First Benchmark Run' step-by-step walkthrough#63
Open
JacobPEvans-personal wants to merge 2 commits into
Open
🤖 Fix #51: docs: write 'First Benchmark Run' step-by-step walkthrough#63JacobPEvans-personal wants to merge 2 commits into
JacobPEvans-personal wants to merge 2 commits into
Conversation
There was a problem hiding this comment.
Code Review
This pull request introduces a comprehensive step-by-step walkthrough guide (docs/first-benchmark-run.md) for running a first MLX benchmark, from setting up the repository and verifying the inference stack to publishing and viewing results on Hugging Face. It also updates the README.md to link to this new guide and updates the placeholder for the Hugging Face token. There are no review comments to address, and I have no additional feedback to provide.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #51
Problem
README.mdshows a 3-step CLI block (lm-eval → dry-run → publish) but jumps over real-worldsetup questions: how to bring up vllm-mlx + llama-swap, what
max_gen_toks=4096means, how tohandle slow models or timeouts, and the difference between dry-run and a real publish.
Approach
New
docs/first-benchmark-run.mdwalks through a complete first run end-to-end in 7 steps(model setup → inference check → lm-eval dry run → envelope inspection → dry-run publish →
real publish → HF Space viewer) with a Common Pitfalls section covering the most frequent
failure modes. Cross-link added in README's Usage section.
Files changed
docs/first-benchmark-run.md— new 7-step walkthrough doc with Common Pitfalls sectionREADME.md— add getting-started callout linking to the walkthrough; also de-quotesHF_TOKENplaceholder for clarityCI status
none — no CI workflows triggered on docs-only change
Self-review
This PR was drafted by Issue Solver and is opened as a DRAFT for human review before merge.
The Hard Rules in the prompt enforce: signed commits via Contents API, no dependency changes,
no infra/workflow edits, secret-pattern pre-flight scan.
Generated by Issue Solver — prompt source: https://github.com/JacobPEvans/claude-code-routines/blob/main/routines/issue-solver.prompt.md