dataiku / dataiku/dataiku-api-client-python
Incorrect documentation on `get_scoring_jar_stream` and `get_scoring_pmml_stream`
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 44
- Forks
- 29
- Ø Merge
- 3 Std. 34 Min.
- Gemergte PRs (30 T.)
- 2
Beschreibung
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.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Öffne dataikuapi/dss/ml.py bei der Dokumentation für get_scoring_jar_stream und get_scoring_pmml_stream, die ungefähr bei den Zeilen 2619 und 2643 verlinkt ist. Aktualisiere beide Beschreibungen, um widerzuspiegeln, dass sie requests.Response-Objekte statt dateiähnlicher Objekte zurückgeben, die geschlossen werden müssen, und bestätige, dass die dokumentierte Verwendung mit response.content übereinstimmt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 1/5
- Geschätzter Aufwand
- Unter einer Stunde
- Aktivitätsstatus
- Veraltet
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 55/100