pytorch/serve

[Educational] Typing `.py` files iteratively with mypy

Open

#1,512 opened on Mar 15, 2022

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Java (790 forks)batch import
good first issue

Repository metrics

Stars
 (3,844 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

We just added #1858 support so a good first issue for anyone new to torchserve or open source python projects in general I'd recommend the following

  1. Pick any file in serve/ts
  2. Add type annotations - for an example you can checkout https://github.com/pytorch/serve/blob/master/ts/context.py
  3. Run mypy path_to_file_you_annotated.py
  4. If you don't see any issues then make a PR and make sure the mypy lint action passes

Contributor guide

Research direction
Pick any Python file in the serve/ts directory, add type annotations following the example in ts/context.py, run mypy to check, then submit a pull request.
Tech stack
pythonpytorch
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90