# Papers with Code is now open-source

> Source: <https://github.com/huggingface/paperswithcode>
> Published: 2026-10-27 09:03:40+00:00

Papers with Code makes open AI research and its artifacts accessible: papers, code, models, datasets, tasks, methods, and benchmark leaderboards. It recreates the original paperswithcode.com, which Meta retired in 2025, and keeps it up to date with automated imports from Hugging Face, arXiv, GitHub, and public leaderboards.

**Live site:** [https://paperswithcode.co](https://paperswithcode.co)

- **Paper catalog.** arXiv and external papers with official code, project
pages, Hugging Face models, datasets, and Spaces, plus thumbnails, TL;DRs,
lineage, and a Markdown reader.
- **Taxonomy.** Browsable tasks, methods, datasets, frameworks, conferences,
organizations, and authors, with trending views.
- **Leaderboards.** Paper-native evaluation results on benchmarks, plus
scheduled syncs of external leaderboards.
- **Search.** Hybrid lexical (`pg_trgm` ) and semantic (`pgvector` ) paper
retrieval.
- **Public API.** A REST API under`/api/v1/` that stays compatible with the
original[Papers with Code API client](https://github.com/paperswithcode/paperswithcode-client) .
OpenAPI docs are served at`/docs` .
- **Research chat (optional).** An assistant grounded in the catalog through the
Papers with Code MCP tools.
- **Curation automation.** Scheduled jobs and agent workflows import daily
papers, link tasks and methods, refresh stars and citations, and propose
evaluations.

| Layer | Technology | 
|---|---|
| Frontend | React 18, TypeScript, Vite, TanStack Query, shadcn/ui, Tailwind CSS | 
| Backend | Python 3.12, FastAPI, SQLAlchemy 2, Pydantic | 
| Database | PostgreSQL 16 with the `vector` and`pg_trgm` extensions | 
| Tooling | [uv](https://docs.astral.sh/uv/) , npm, Ruff, pytest | 
| Hosting | nginx serving immutable releases ( [deploy/](https://github.com/huggingface/paperswithcode/blob/main/deploy) ) | 

| Path | Contents | 
|---|---|
| [`backend/`](https://github.com/huggingface/paperswithcode/blob/main/backend) | FastAPI app ( `main.py` ),`routers/` (HTTP adapters),`services/` (domain logic),`models/` (API models;`models/database/` for SQLAlchemy models),`database/migrations/` (SQL migrations),`cli.py` (the`pwc` maintenance CLI), and`tests/` | 
| [`frontend/`](https://github.com/huggingface/paperswithcode/blob/main/frontend) | React single-page app | 
| [`deploy/`](https://github.com/huggingface/paperswithcode/blob/main/deploy) | Release, rollback, nginx, systemd, and environment templates for the hosted site | 
| [`.github/workflows/`](https://github.com/huggingface/paperswithcode/blob/main/.github/workflows) | CI and scheduled data jobs; job scripts live in `scripts/` | 
| [`jobs/`](https://github.com/huggingface/paperswithcode/blob/main/jobs) | Paper-curation runner for Hugging Face Jobs | 
| [`docs/`](https://github.com/huggingface/paperswithcode/blob/main/docs) | Development, data, database, and operations guides | 

```
git clone https://github.com/huggingface/paperswithcode.git
cd paperswithcode
uv sync
cd frontend && npm install && cd ..
createdb paperswithcode
psql -d paperswithcode -c 'CREATE EXTENSION vector' -c 'CREATE EXTENSION pg_trgm'
```

Settings are read from `PWC_`-prefixed environment variables (see
[`backend/config.py`](https://github.com/huggingface/paperswithcode/blob/main/backend/config.py)). Put them in `backend/keys.env`,
which git ignores:

```
PWC_DB_HOST=localhost
PWC_DB_PORT=5432
PWC_DB_NAME=paperswithcode
PWC_DB_USER=postgres
PWC_DB_PASSWORD=
PWC_ENVIRONMENT=development

# Optional: higher Hugging Face and GitHub rate limits for imports
PWC_HF_TOKEN=
PWC_GITHUB_TOKEN=
```

Chat, curation, and hosted integrations need more credentials; the
templates in [`deploy/env/`](https://github.com/huggingface/paperswithcode/blob/main/deploy/env) list them.

```
uv run --env-file backend/keys.env python -m backend.database.connection init
uv run --env-file backend/keys.env backend/run_server.py   # API on http://localhost:8000
cd frontend && npm run dev                                   # app on http://localhost:8080
```

The Vite dev server proxies `/api` to the backend on port 8000. The schema
starts empty; use the `pwc` CLI below to index papers.

```
uv run pytest backend/tests/paper -q    # run the suite you touched
cd frontend && npm run lint
```

Tests that need PostgreSQL refuse to run unless `PWC_TEST_DATABASE=1` points
them at a disposable database. The
[development guide](https://github.com/huggingface/paperswithcode/blob/main/docs/development-guide.md) lists the test suites and
conventions. [pre-commit](https://pre-commit.com/) runs Ruff on each commit;
run `pre-commit install` once to enable it.

`uv sync` installs a `pwc` command for catalog maintenance. Run
`uv run pwc --help` for the full list. Common commands:

```
uv run --env-file backend/keys.env pwc paper index 1706.03762    # index or refresh an arXiv paper
uv run --env-file backend/keys.env pwc paper info 1706.03762
uv run --env-file backend/keys.env pwc search "vision-language models"
uv run --env-file backend/keys.env pwc paper add-external https://example.org/research
uv run --env-file backend/keys.env pwc benchmark add "ExampleBench" \
  --task question-answering --metric Accuracy --source-paper 2501.12345
uv run --env-file backend/keys.env pwc thumbnail 1706.03762      # regenerate a thumbnail
uv run --env-file backend/keys.env pwc cron health               # scheduled-job health
```

For read-only access to the public catalog from any machine, install the
standalone [`pwc-cli`](https://github.com/huggingface/pwc-cli):

```
uv tool install 'git+https://github.com/huggingface/pwc-cli.git#subdirectory=standalone_cli'
```

paperswithcode.co runs production and staging as immutable releases behind
nginx; see [docs/deployment.md](https://github.com/huggingface/paperswithcode/blob/main/docs/deployment.md) and
[docs/operations.md](https://github.com/huggingface/paperswithcode/blob/main/docs/operations.md). Durable artifacts live in private
Hugging Face buckets in the `huggingface` organization:

| Bucket | Purpose | Setting | 
|---|---|---|
| `huggingface/pwc-papers-content` | Paper Markdown used by the reader and `pwc paper read` | `PWC_PAPER_MARKDOWN_HF_BUCKET_ID` | 
| `huggingface/pwc-thumbnail` | Generated paper thumbnails | `PWC_THUMBNAIL_HF_BUCKET_ID` | 
| `huggingface/pwc-paper-embeddings` | Embedding exports and experiments | `hf://buckets/huggingface/pwc-paper-embeddings/...` | 
| `huggingface/paperswithcode-backups` | Database backups | `PWC_POSTGRES_BACKUP_BUCKET` | 

- [docs/development-guide.md](https://github.com/huggingface/paperswithcode/blob/main/docs/development-guide.md) : conventions, test suites, and local checks
- [docs/public-api.md](https://github.com/huggingface/paperswithcode/blob/main/docs/public-api.md) : the public REST API
- [docs/database.md](https://github.com/huggingface/paperswithcode/blob/main/docs/database.md) : database access and security
- [docs/DATABASE_SCHEMA_UML.md](https://github.com/huggingface/paperswithcode/blob/main/docs/DATABASE_SCHEMA_UML.md) : schema reference
- [docs/data-workflows.md](https://github.com/huggingface/paperswithcode/blob/main/docs/data-workflows.md) : datasets, evaluations, metrics, and tasks
- [docs/operations.md](https://github.com/huggingface/paperswithcode/blob/main/docs/operations.md) : scheduled jobs and monitoring
- [docs/deployment.md](https://github.com/huggingface/paperswithcode/blob/main/docs/deployment.md) : releases, nginx, and smoke checks
- [.github/workflows/scripts/README.md](https://github.com/huggingface/paperswithcode/blob/main/.github/workflows/scripts/README.md) : scheduled job scripts
- [AGENTS.md](https://github.com/huggingface/paperswithcode/blob/main/AGENTS.md) : instructions for coding agents

Please report vulnerabilities privately; see [SECURITY.md](https://github.com/huggingface/paperswithcode/blob/main/SECURITY.md).

Papers with Code is licensed under the [Apache License 2.0](https://github.com/huggingface/paperswithcode/blob/main/LICENSE).