Spaces:
Running on CPU Upgrade
Running on CPU Upgrade
|
Download standalone_cli/README.md from huggingface/paperswithcode-mcp: direct link, hf CLI and curl.
- Browser
- Download file 8.68 kB
-
https://huggingface.co/spaces/huggingface/paperswithcode-mcp/resolve/main/standalone_cli/README.md
- Command line
-
hf download hf://spaces/huggingface/paperswithcode-mcp/standalone_cli/README.md
-
curl -L -o README.md https://huggingface.co/spaces/huggingface/paperswithcode-mcp/resolve/main/standalone_cli/README.md
8.68 kB
| # pwc CLI | |
| A lightweight, read-only client for the public Papers With Code catalog API. | |
| Public reads are anonymous: no login or token is required. | |
| ```bash | |
| uv tool install ./standalone_cli | |
| pwc search "small vision language models" --limit 10 | |
| pwc paper info 2501.01234 | |
| pwc paper info 2501.01234 --include-resources | |
| pwc paper info 2501.01234 --include-evals | |
| pwc paper info "Attention Is All You Need" | |
| pwc paper read 2501.01234 | |
| pwc task --name "scene-text-recognition" | |
| pwc task list --area Vision | |
| pwc task list --group-by-area | |
| pwc method --name Transformer | |
| pwc method list --area Audio | |
| pwc conference --name "CVPR 2025" | |
| pwc conference list --year 2025 | |
| pwc organization --name NVIDIA | |
| pwc organization list --featured-only | |
| pwc framework --name vLLM | |
| pwc framework list --platform gpu | |
| pwc benchmark list | |
| pwc skills add | |
| ``` | |
| Every `PAPER` argument accepts an arXiv ID, numeric external-paper ID, or quoted | |
| exact title. Title matching is case-insensitive and rejects ambiguity. | |
| When `pwc paper info` or `pwc paper read` names a paper Papers With Code has not | |
| indexed, stderr shows "Not indexed on Papers With Code — available at:" with its | |
| public links (arXiv, Hugging Face Papers, DOI, code) and metadata from the | |
| `papers/{reference}/public-metadata` API. Stdout and the not-found exit status | |
| are unchanged; an arXiv or Hugging Face URL the API maps to a catalog paper is | |
| read from the catalog. | |
| `pwc paper info PAPER --include-evals` fetches every evaluation associated with | |
| the resolved paper. Human-readable output adds an Evaluations Markdown table; | |
| `--json` adds an `evaluations` object containing `count` and `results`. | |
| Normal paper-info output includes the names of tagged organizations when present. | |
| Task lists and benchmark lists render grouped Markdown in a terminal. Use | |
| `--flat` for paginated tables or `--group-by-area` to force Markdown when | |
| piping. Task, search, pagination, ordering, and open-model filters take | |
| precedence over `--group-by-area` and select task-scoped flat output. Grouped | |
| benchmarks include their name, full name when distinct, slug, and ID. | |
| Task-scoped benchmark lists also include the slug and ID alongside the best | |
| model, paper, and code repository, using aligned columns even when output is | |
| captured by an agent or another process. Inspect one with | |
| `pwc benchmark --name IDENTIFIER`; either identifier is accepted. Benchmark | |
| details use an aligned table in a terminal and Markdown when piped or captured. | |
| Other list and search output uses aligned columns in a terminal and lossless | |
| TSV when captured. | |
| Paper discovery commands accept `--implementation-coverage` to add | |
| `official_implementation` and `code_repositories` columns. JSON and | |
| `pwc paper info` always include those fields. The boolean reports whether the | |
| catalog links an official repository to any version of the paper; `false` does | |
| not prove that no official code exists elsewhere. `pwc search` and | |
| `pwc paper list` accept `--has-official-implementation` and fail closed unless | |
| the API confirms the filter. | |
| Task lists report each task's direct paper, benchmark, and evaluation counts in | |
| both grouped and flat output. | |
| `pwc task --name NAME` accepts an exact task name, slug, or ID and renders the | |
| task-page details in CLI form: area, description, hierarchy, research trends, | |
| recommended frameworks, sister tasks, subtasks, common methods, benchmarks, | |
| and trending papers. Direct benchmarks follow the ranking returned by the | |
| task benchmark-trends API; the CLI does not calculate or re-sort trend scores. | |
| Add `--json` for the complete structured payload. | |
| Methods, conferences, organizations, and frameworks share the same detail | |
| shape as tasks: pass an exact name, slug, or ID to `--name`. Their `list` | |
| subcommands retain entity-specific filters such as method area, conference | |
| year, featured organizations, and framework domain, category, or platform. | |
| `pwc paper list` accepts exact `--task`, `--method`, `--conference`, | |
| `--framework`, and `--organization` filters. Repeat `--author` with exact | |
| normalized names, numeric IDs, or `@HF_USERNAME` references to require every | |
| listed co-author. Combine these filters to require every selected identity, | |
| tag, or catalog association. The CLI fails closed if the selected API does not | |
| confirm that it applied every requested catalog filter. | |
| Publication date ranges use inclusive `--start-date YYYY-MM-DD` and | |
| `--end-date YYYY-MM-DD` bounds; the start date cannot be later than the end date. | |
| For example, find an author's papers on a stated topic in newest-first order: | |
| ```bash | |
| pwc paper list --author "Kaiming He" --search drift \ | |
| --order-by date_published --order-dir desc | |
| ``` | |
| Leaderboard inspection supports numeric multi-metric selection: | |
| ```bash | |
| pwc benchmark --name coco-val2017 --require-metrics mAP,FPS | |
| pwc benchmark --name coco-val2017 --min FPS=60 --sort mAP:desc | |
| pwc benchmark --name coco-val2017 --pareto mAP:higher,FPS:higher | |
| pwc benchmark --name wikitext-103 --is-open true --max-parameters 3B | |
| ``` | |
| `--min` and `--max` are repeatable. Metric names are case-insensitive. Metric | |
| selection scans the bounded leaderboard before applying `--limit`; it fails | |
| explicitly rather than returning an incomplete selection if a leaderboard | |
| exceeds the 1,000-row scan ceiling. | |
| `--max-parameters SIZE` keeps models at or below an inclusive parameter limit. | |
| SIZE accepts case-insensitive decimal suffixes such as `500M`, `1.5B`, and | |
| `3B`, plus raw integers. Parameter-constrained results exclude models whose | |
| parameter count is unknown or inconsistent across metric rows and fail closed | |
| against APIs that cannot confirm support. Human-readable leaderboard output | |
| includes a Parameters column; JSON retains the exact `num_parameters` integer. | |
| `pipx install ./standalone_cli` is also supported. `PWC_API_URL` selects a | |
| compatible versioned API origin; it defaults to | |
| `https://paperswithcode.co/api/v1`. Run `pwc --help` for the complete read-only | |
| command tree. The stable exit codes are 0 (success), 2 (usage), 3 (network or | |
| server failure), and 4 (invalid response). | |
| Install the version-matched Skill for coding agents with `pwc skills add`. | |
| Add `--global` to use `~/.agents/skills`, `--claude` to also link it for Claude | |
| Code, or `--dest PATH` for another harness. | |
| ## Edit a paper with your agent | |
| Requires a server with the paper-edit API enabled. Sign in using the browser | |
| link and confirm the paper and code. This grants one hour of write access to | |
| that paper; each batch publishes immediately under your HF username. | |
| ```bash | |
| pwc auth login --paper 123 # --no-browser for remote machines | |
| pwc paper edit export 123 --output edits.json | |
| # Add explicit operations to edits.json; current is reference material. | |
| pwc paper edit preview 123 --file edits.json | |
| pwc paper edit submit 123 --file edits.json | |
| pwc auth status --paper 123 | |
| pwc auth logout --paper 123 | |
| ``` | |
| For example, add the following to the exported `operations` array, substituting | |
| real existing task/dataset/metric identifiers. A metrics dictionary lets you | |
| submit multiple scores without repeating model and benchmark details: | |
| ```json | |
| { | |
| "section": "evaluations", | |
| "payload": { | |
| "task_id": 1, | |
| "dataset_id": 2, | |
| "model_name": "Example model", | |
| "methodology": "Test split, zero-shot; Table 3", | |
| "metrics": {"Accuracy": 90.5, "F1": 88.1}, | |
| "source_url": "https://arxiv.org/abs/2601.00001" | |
| } | |
| } | |
| ``` | |
| Add `evaluation_id` alongside `section` to correct a row. Other supported | |
| sections are tasks, methods, repositories, project_pages, hf_artifacts, | |
| x_threads, and source_url. `x_threads` takes `{"x_threads": [post URLs]}` in | |
| display order (at most 10); link only posts in which the paper's authors or | |
| their organization introduce the paper. Section replacements must retain unrelated entries. Evaluation | |
| updates preserve omitted fields. Existing benchmark/metric definitions are | |
| required; evaluation deletion and rank overrides are excluded. | |
| Batches contain at most 50 operations and 1 MiB. Invalid or stale batches write | |
| nothing. Retry uncertain network results with the exact same document and | |
| idempotency key. For a stale revision, export again and reconcile before retrying. | |
| Accounts share a 20-distinct-paper daily limit (UTC) and 30-publication-per-minute | |
| limit across the website and CLI; admins are exempt. `pwc skills add --force` | |
| installs the detailed agent workflow. | |
| Credentials are stored in mode-0600 files inside the mode-0700 directory | |
| `~/.config/pwc/edit-credentials`, keyed by API base URL and paper. Never copy | |
| these files into prompts or repositories. `PWC_API_URL` selects the target API; | |
| editing requires HTTPS, except on loopback development servers, and refuses | |
| redirects. Public read commands never load edit credentials. | |