aws / aws/sagemaker-python-sdk
No proper API reference is generated for SageMaker SDK v3
- Lenguaje dominante
- Python
- Estrellas
- 2.3k
- Forks
- 1.3k
- Merge medio
- 1 d 22 h
- PR fusionados (30 d)
- 35
Descripción
**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.
Guía de contribución
Línea de trabajo
Comienza localizando la implementación de sagemaker.ai_registry.dataset.DataSet y los puntos de entrada existentes del SDK para la generación de documentación. Compara la referencia de API esperada con el ejemplo de referencia de API de scikit-learn y, a continuación, verifica que el constructor y los parámetros de DataSet, incluida la configuración de la longitud máxima de contexto, se puedan descubrir mediante la búsqueda de documentación.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- aws, python
- Área
- documentation, machine-learning
- Tipo de issue
- Documentación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Tranquilo
- Claridad
- Bastante claro
- Aptitud para principiantes
- 48/100