deepspeedai / deepspeedai/DeepSpeed

[REQUEST] adding type hints and `py.typed` metadata

Open
#6,988 1 comment 1 reaction 1 assignee View on GitHub

@loadams is already working on this.

Since Feb 11, 2025.

enhancement
Dominant language
Python
Stars
43.1k
Forks
5k
Avg merge
4d 15h
Merged PRs (30d)
112

Description

Is your feature request related to a problem? Please describe.

With deepspeed==0.15.4, mypy==1.14.1 reports deepspeed is untyped:

error: Skipping analyzing "deepspeed.utils": module is installed, but missing library stubs or py.typed marker  [import-untyped]
    from deepspeed.utils import logger
    ^
Skipping analyzing "deepspeed.checkpoint.constants": module is installed, but missing library stubs or py.typed marker  [import-untyped]
    from deepspeed.checkpoint.constants import (
    ^

This is because deepspeed doesn't have either type hints or a py.typed marker file.

Describe the solution you'd like

Adding type hints and a py.typed marker file so type checkers can inspect deepspeed to prevent TypeError-related bugs.

Describe alternatives you've considered

A workaround is to disable this error via mypy configuration:

[[tool.mypy.overrides]]
ignore_missing_imports = true
module = [
    "deepspeed.*",
]

Additional context

N/a

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.