facebookresearch/fmmax

Documentation

オープン

#35 opened on 2023/08/30

GitHub で見るコントリビューターガイド
 (0 件のコメント) (1 件のリアクション) (0 人の担当者)Jupyter Notebook (15 件のフォーク)auto 404
documentationenhancementgood first issue

Repository metrics

Stars
 (149 個のスター)
PR merge metrics
 (PR metrics pending)

説明

Would be good to export the API docstrings into some documentation. The examples could be exported too (even better would be to export notebooks with the accompanying text explaining things).

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

調査方針
Sphinxなどのドキュメント生成ツールを使用して、ドキュメント文字列からAPIドキュメントを自動生成し、Jupyterノートブックを例として含めます。出力がユーザーフレンドリーで主要な機能をカバーしていることを確認します。
技術スタック
python
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
新着
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
なし
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
80