keras-team/autokeras

Adding types information on the API surface.

Open

#918 建立於 2020年1月20日

在 GitHub 查看
 (2 留言) (1 反應) (0 負責人)Python (9,025 star) (1,420 fork)batch import
contribution welcomegood first issuepinned

描述

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.

貢獻者指南

技術棧
python
領域
api
議題類型
refactor
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Basic Python typingFamiliarity with AutoKeras API
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70
研究方向
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.
Adding types information on the API surface. · keras-team/autokeras#918 | Good First Issue