dataiku / dataiku/dataiku-api-client-python

Incorrect documentation on `get_scoring_jar_stream` and `get_scoring_pmml_stream`

Đang mở
#187 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Ngôn ngữ chính
Python
Star
44
Fork
29
Merge trung bình
3 giờ 34 phút
Pull request đã merge (30 ngày)
2

Mô tả

I'm using DSS version 9.0.3. The documentation for ML model export functions get_scoring_jar_stream and get_scoring_pmml_stream says that they should return file-like objects that need to be closed after use.

In fact they return requests.Response objects, so correct usage is along the lines of

response = model_details.get_scoring_pmml_stream()
pmml_xml = response.content

The documentation should be updated to reflect this: see here and here.

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Mở dataikuapi/dss/ml.py tại phần tài liệu của get_scoring_jar_stream và get_scoring_pmml_stream, được liên kết quanh các dòng 2619 và 2643. Cập nhật cả hai mô tả để phản ánh rằng chúng trả về các đối tượng requests.Response thay vì các đối tượng giống tệp cần được đóng, đồng thời xác nhận rằng cách sử dụng được ghi trong tài liệu phù hợp với response.content.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
python
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
1/5
Thời gian dự kiến
Dưới một giờ
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Đặc tả rõ ràng
Mức phù hợp với người mới
55/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.