pytorch/ignite

Improve code coverage

Open

#1,790 opened on Mar 14, 2021

View on GitHub
 (7 comments) (4 reactions) (0 assignees)Python (4,313 stars) (602 forks)batch import
HacktoberfestPyDataGlobalenhancementhelp wanted

Description

Our project code coverage start to decrease with new features and reworked tests. We are now ~95% but were 96% recently and around ~98% the last year...

The idea is to identify the uncovered parts of code inspecting here, for example: https://codecov.io/gh/pytorch/ignite/tree/master/ignite and draft a PR with new tests.

Some of new test can be very simple and others could be very sophisticated to enter a particular code line. Let's improve the coverage of all modules, except distributed for instance.

  • ignite.base
  • ignite.contrib.engines
  • ignite.contrib.handlers
  • ignite.contrib.metrics
  • ignite/engine/__init__.py
  • ignite/engine/engine.py
  • ignite/engine/events.py
  • ignite/handlers/checkpoint.py
  • ignite.metrics

Contributor guide

Tech stack
python
Domain
backendtesting
Issue type
test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Python testingPyTorch basicsCode coverage tools
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Review the codecov link for pytorch/ignite to identify uncovered lines in engine.py. Look at existing tests for pattern. Write new tests to cover missing branches. Consider that many modules have been completed, so focus on engine.py.