aws / aws/sagemaker-python-sdk
No proper API reference is generated for SageMaker SDK v3
- 主要言語
- Python
- スター
- 2.3k
- フォーク
- 1.3k
- 平均マージ
- 1日 22時間
- マージ済み PR(30日)
- 35
説明
**What did you find confusing? Please describe.**
The customer tried to understand the structure of sagemaker.ai_registry.dataset.DataSet and clarify how to configure max context length for datasets used in RLAIF. They failed to do it as no proper API Reference is provided.
**Describe how documentation can be improved**
Please provide proper API Reference asap, otherwise people are lost in the tutorials and have no idea about fine-tuned and advanced system capabilities and configurations. It can be generated automatically from the code.
Example: https://scikit-learn.org/stable/api/index.html.
**Additional context**
Search is not working: Searching for "sagemaker.ai_registry.dataset.DataSet" did not bring any information about the DataSet constructor method and parameters.
コントリビューションガイド
調査の方向性
まず、sagemaker.ai_registry.dataset.DataSet の実装と、SDK に既に存在するドキュメント生成のエントリーポイントを見つけます。期待される API リファレンスを scikit-learn の API リファレンスの例と比較し、そのうえで、最大コンテキスト長の設定を含む DataSet のコンストラクターとパラメーターが、ドキュメント検索から見つけられることを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- aws, python
- 領域
- documentation, machine-learning
- issue の種類
- ドキュメント
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 静か
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 48/100