dataiku / dataiku/dataiku-api-client-python
Incorrect documentation on `get_scoring_jar_stream` and `get_scoring_pmml_stream`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 44
- Forks
- 29
- Avg merge
- 3h 34m
- Merged PRs (30d)
- 2
Description
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.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open dataikuapi/dss/ml.py at the documentation for get_scoring_jar_stream and get_scoring_pmml_stream, linked around lines 2619 and 2643. Update both descriptions to reflect that they return requests.Response objects rather than file-like objects requiring closure, and confirm the documented usage matches response.content.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100