microsoft/DeepSpeedNew scan
96/ 100 · A

A top-tier open source project. Docs, tests, and CI are all in excellent shape.

DeepSpeed is a deep learning optimization library that makes distributed training and inference easy, efficient, and effective.

Python42,536 starsApache-2.0updated 1d ago

Outstanding work. A score of 96/100 puts this repo in a very small tier of truly well-engineered open source projects.

DocumentationREADME, setup, examples, license
97
EngineeringTests, CI, linting, lockfiles
93
Project healthDescription, activity, stars, deps
100

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringIssue

    Add a lint step to catch style issues automatically.

  2. 2
    CI/CD
    EngineeringInfo

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

  3. 3
    CI/CD
    EngineeringInfo

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

Detailed breakdown

Documentation

97
  • README100
    • README is present.
    • README is well structured with multiple sections.
    • README includes screenshots or visuals. Great for first impressions.
    • README has code examples.
    • README links to a live demo or deployed app.
    • README includes status badges.
  • Install and run instructions90
    • README documents how to install the project.
    • README documents how to run the project.
    • No .env.example found (−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 guide97
    • Contributing guide is detailed and thorough.
    • Contributing guide includes setup/install instructions.
    • Contributing guide lacks a code style section (−8 pts).Describe your linting/formatting rules and how to run them.
    • Contributing guide explains how to run tests.
    • Contributing guide describes the PR/review workflow.
    • Contributing guide includes code examples.
    • Code of conduct present.

Engineering

93
  • Tests100
    • Test files detected (csrc/aio/py_test/test_ds_aio.py).
    • Pytest configured in Python project config with test files present.
  • CI/CD85

    Not applicable?

    • CI is configured (.github/workflows/aws-torch-latest-full.yml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI does not run a lint or format check (−15 pts).Add a lint step to catch style issues automatically.
    • 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.
  • Linting and formatting100
    • Linter or formatter configured (.flake8).
  • Reproducibility80
    • Lockfile present (requirements/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 templates100
    • Issue or PR templates present.
    • Security policy present.

Project health

100
  • Dependency manifest100
    • Dependency manifest found (setup.cfg).
  • Repository metadata100
    • Repository has a description.
    • Primary language detected: Python.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 42,536 stars.
  • Housekeeping100
    • .gitignore present.
Repository files45 root entries
  • .github
    Good: CI is configured (.github/workflows/aws-torch-latest-full.yml).
    Good: Issue or PR templates present.
  • accelerator
  • azure
  • benchmarks
  • bin
  • blogs
  • ci
  • csrc
    Good: Test files detected (csrc/aio/py_test/test_ds_aio.py).
  • deepspeed
  • docker
    Good: Environment pinned via docker/Dockerfile.
  • docs
  • examples
  • op_builder
  • release
  • requirements
    Good: Lockfile present (requirements/requirements.txt). Installs are reproducible.
  • scripts
  • tests
  • .clang-format
  • .flake8
    Good: Linter or formatter configured (.flake8).
  • .gitignore
    Good: .gitignore present.
  • .gitmodules
  • .pre-commit-config.yaml
  • .pylintrc
  • .readthedocs.yml
  • .style.yapf
  • AGENTS.md
  • build_win.bat
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CODEOWNERS
  • COMMITTERS.md
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • environment.yml
  • GOVERNANCE.md
  • install.sh
  • LICENSE
    Good: Licensed under Apache-2.0.
  • Makefile
  • MANIFEST_win.in
  • MANIFEST.in
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Good: README has code examples.
    Good: README links to a live demo or deployed app.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • SECURITY.md
    Good: Security policy present.
  • setup.cfg
    Good: Dependency manifest found (setup.cfg).
  • setup.py
  • THIRD_PARTY_NOTICES.md
  • version.txt