aws / aws/sagemaker-python-sdk

No proper API reference is generated for SageMaker SDK v3

Ouverte
#5,648 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
Python
Étoiles
2.3k
Forks
1.3k
Merge moyen
1 j 22 h
PR mergées (30 j)
35

Description

**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.

Image

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par localiser l’implémentation de sagemaker.ai_registry.dataset.DataSet et les points d’entrée existants du SDK pour la génération de documentation. Comparez la référence d’API attendue avec l’exemple de référence d’API de scikit-learn, puis vérifiez que le constructeur et les paramètres de DataSet, y compris la configuration de la longueur maximale du contexte, sont découvrables via la recherche dans la documentation.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
aws, python
Domaine
documentation, machine-learning
Type d'issue
Documentation
Difficulté
4/5
Temps estimé
3-5 jours
Activité
Calme
Clarté
Plutôt claire
Accessibilité débutants
48/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.