aws / aws/sagemaker-python-sdk
No proper API reference is generated for SageMaker SDK v3
- Vorherrschende Sprache
- Python
- Sterne
- 2.3k
- Forks
- 1.3k
- Ø Merge
- 1 T. 22 Std.
- Gemergte PRs (30 T.)
- 35
Beschreibung
**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.
Beitragsleitfaden
Rechercherichtung
Beginne damit, die Implementierung von sagemaker.ai_registry.dataset.DataSet und die vorhandenen Einstiegspunkte des SDK zur Dokumentationsgenerierung zu finden. Vergleiche die erwartete API-Referenz mit dem Beispiel der scikit-learn API-Referenz und überprüfe anschließend, dass der DataSet-Konstruktor und seine Parameter, einschließlich der Konfiguration der maximalen Kontextlänge, über die Dokumentationssuche auffindbar sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- aws, python
- Bereich
- documentation, machine-learning
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Ruhig
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 48/100