facebookresearch/faiss

0

/ 100

Documentation81
Engineering77
Health100
C++40,347MIT5d ago
Grade a repo

Popular and well-maintained. A little polish away from elite status.

A library for efficient similarity search and clustering of dense vectors.

Documentation

81

Contributing guide5pt66

Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

README12pt70

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

77

Reproducibility6pt10

No dependency lockfile found (−70 pts).

→ Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.

Tests18pt80

Test files detected (benchs/avx512_result_handlers/test_bitonic.py).

CI/CD14pt85

CI is configured (.github/workflows/build-pip-gpu.yml).

Linting and formatting5pt100

Linter or formatter configured (faiss/.flake8).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (pyproject.toml).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository files26 root entries
  • .github
    Good: CI is configured (.github/workflows/build-pip-gpu.yml).
    Good: Issue or PR templates present.
  • benchs
    Good: Test files detected (benchs/avx512_result_handlers/test_bitonic.py).
  • c_api
  • cmake
  • conda
  • contrib
  • demos
  • faiss
    Good: Linter or formatter configured (faiss/.flake8).
    Good: Environment pinned via faiss/cppcontrib/docker_dev/Dockerfile.
  • misc
  • perf_tests
  • tests
  • tutorial
  • .clang-format
  • .dockerignore
  • .gitignore
    Good: .gitignore present.
  • CHANGELOG.md
  • CMakeLists.txt
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
    Issue: Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Good: Contributing guide describes the PR/review workflow.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • Doxyfile
  • INSTALL.md
  • LICENSE
    Good: Licensed under MIT.
  • pyproject-gpu.toml
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Issue: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    Good: README has code examples.
    Good: README links to a live demo or deployed app.
    Issue: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • THIRD_PARTY_NOTICES