facebookresearch/detectron2New scan
82/ 100 · B

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

Detectron2 is a platform for object detection, segmentation and other visual recognition tasks.

Python34,548 starsApache-2.0updated 9d ago
DocumentationREADME, setup, examples, license
82
EngineeringTests, CI, linting, lockfiles
78
Project healthDescription, activity, stars, deps
92

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringInfo

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

  2. 2
    CI/CD
    EngineeringInfo

    Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.

  3. 3
    README
    DocumentationWarning

    Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.

Detailed breakdown

Documentation

82
  • README70
    • README is present.
    • README is well structured with multiple sections.
    • No screenshots or images in the README (−20 pts).Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    • README has code examples.
    • README links to a live demo or deployed app.
    • No status badges in the README (−10 pts).Add CI/build status badges from shields.io or your CI provider to signal project health.
  • Install and run instructions90
    • README documents how to install the project.
    • README documents how to run the project.
    • If your project uses environment variables, add a .env.example listing them (+10 pts).Add a .env.example listing all required environment variables so contributors know what to set up.
  • License100
    • Licensed under Apache-2.0.
  • Contributing guide75
    • CONTRIBUTING guide or docs directory present.
    • Code of conduct present.

Engineering

78
  • Tests60
    • Test files detected (detectron2/modeling/test_time_augmentation.py).
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/check-template.yml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI workflow runs a lint or format check.
    • Optional: add type checking to CI.Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.
    • Optional: report test coverage in CI.Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.
    • CI caches dependencies for faster runs.
    • CI tests across multiple environments or versions.
  • Linting and formatting60
    • Linter or formatter configured (.flake8).
  • Reproducibility80
    • Lockfile present (docs/requirements.txt). Installs are reproducible.
    • Environment pinned via docker/Dockerfile.
    • No Dependabot config (adding it earns up to +20 pts).Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.
  • Issue and PR templates90
    • Issue or PR templates present.
    • Optional: add a SECURITY.md.A SECURITY.md explains how to responsibly disclose vulnerabilities. Worth adding once the project has real users.

Project health

92
  • Dependency manifest100
    • Dependency manifest found (setup.cfg).
  • Repository metadata70
    • Repository has a description.
    • Primary language detected: Python.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 34,548 stars.
  • Housekeeping100
    • .gitignore present.
Repository files21 root entries
  • .github
    Good: CONTRIBUTING guide or docs directory present.
    Good: Code of conduct present.
    Good: CI is configured (.github/workflows/check-template.yml).
    Good: Issue or PR templates present.
  • configs
  • datasets
  • demo
  • detectron2
    Good: Test files detected (detectron2/modeling/test_time_augmentation.py).
  • dev
  • docker
    Good: Environment pinned via docker/Dockerfile.
  • docs
    Good: Lockfile present (docs/requirements.txt). Installs are reproducible.
  • projects
  • tests
  • tools
  • .clang-format
  • .flake8
    Good: Linter or formatter configured (.flake8).
  • .gitignore
    Good: .gitignore present.
  • GETTING_STARTED.md
  • INSTALL.md
  • LICENSE
    Good: Licensed under Apache-2.0.
  • MODEL_ZOO.md
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Warning: 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.
    Info: 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.
  • setup.cfg
    Good: Dependency manifest found (setup.cfg).
  • setup.py