facebookresearch/hydra

Add a standalone page describing @hydra.main() in details.

Open

#845 opened on 2020年8月5日

GitHub で見る
 (4 comments) (2 reactions) (0 assignees)Python (608 forks)batch import
documentationgood first issuetriage

Repository metrics

Stars
 (7,539 stars)
PR merge metrics
 (平均マージ 37d 6h) (30d で 25 merged PRs)

説明

Input from @omry : There are many details that does not fit into the tutorial.

  • the behavior of the return value.
  • support for config passthrough
  • detailed documentation of the parameters

コントリビューターガイド

調査方針
Hydraのドキュメント構造を理解し、戻り値の動作、設定の透過サポート、@hydra.main()のパラメータの詳細なドキュメントをカバーする新しい独立したページを作成します。既存のドキュメントページのスタイルと形式を参照してください。
技術スタック
python
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
半日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
GitPython
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
85