aws / aws/sagemaker-python-sdk

No proper API reference is generated for SageMaker SDK v3

Aperta
#5,648 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Python
Stelle
2.3k
Fork
1.3k
Merge medio
1g 22h
PR unite (30g)
35

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia individuando l’implementazione di sagemaker.ai_registry.dataset.DataSet e i punti di ingresso esistenti dell’SDK per la generazione della documentazione. Confronta il riferimento API previsto con l’esempio di riferimento API di scikit-learn, quindi verifica che il costruttore e i parametri di DataSet, inclusa la configurazione della lunghezza massima del contesto, siano individuabili tramite la ricerca nella documentazione.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
aws, python
Ambito
documentation, machine-learning
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Tranquilla
Chiarezza
Abbastanza chiara
Idoneità per principianti
48/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.