keras-team/autokeras

Adding types information on the API surface.

Open

#918 opened on Jan 20, 2020

View on GitHub
 (2 comments) (1 reaction) (0 assignees)Python (9,025 stars) (1,420 forks)batch import
contribution welcomegood first issuepinned

Description

Adding types on the public API surface would allow us to do some runtime type checking later on and would allow user's IDE to have more info for static analysis.

The functions/signatures to type are the ones listed here https://github.com/keras-team/autokeras/blob/master/autokeras/__init__.py

For the context, see #856 where I add some type information on a ImageClassifier.

This issue can be considered easy to solve (good first issue), it's just long to do because the public API surface is big.

I'll do it but some help is welcome :) make sure to make small pull requests.

Contributor guide

Tech stack
python
Domain
api
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-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
Basic Python typingFamiliarity with AutoKeras API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue specifies adding type hints to functions listed in https://github.com/keras team/autokeras/blob/master/autokeras/ init .py. Reference PR #856 for an example on ImageClassifier. Start by examining the public API in that file and adding Python type annotations, focusing on widely used classes and functions. Ensure consistency with the existing style.