aws / aws/sagemaker-python-sdk
No proper API reference is generated for SageMaker SDK v3
- Ngôn ngữ chính
- Python
- Star
- 2.3k
- Fork
- 1.3k
- Merge trung bình
- 1 ngày 22 giờ
- Pull request đã merge (30 ngày)
- 35
Mô tả
**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.
Hướng dẫn đóng góp
Hướng nghiên cứu
Bắt đầu bằng cách xác định phần triển khai của sagemaker.ai_registry.dataset.DataSet và các điểm vào hiện có của SDK để tạo tài liệu. So sánh tài liệu tham chiếu API dự kiến với ví dụ về tài liệu tham chiếu API của scikit-learn, sau đó xác minh rằng constructor và các tham số của DataSet, bao gồm cả cấu hình độ dài ngữ cảnh tối đa, có thể được tìm thấy thông qua tìm kiếm tài liệu.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- aws, python
- Lĩnh vực
- documentation, machine-learning
- Loại issue
- Tài liệu
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Ít trao đổi
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 48/100