dataiku / dataiku/dataiku-api-client-python
Incorrect documentation on `get_scoring_jar_stream` and `get_scoring_pmml_stream`
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 44
- Forks
- 29
- Merge moyen
- 3 h 34 min
- PR mergées (30 j)
- 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.
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Ouvrez dataikuapi/dss/ml.py à la documentation de get_scoring_jar_stream et get_scoring_pmml_stream, référencée vers les lignes 2619 et 2643. Mettez à jour les deux descriptions pour indiquer qu’elles renvoient des objets requests.Response plutôt que des objets de type fichier nécessitant une fermeture, et confirmez que l’utilisation documentée correspond à response.content.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 1/5
- Temps estimé
- Moins d'une heure
- Activité
- À l'abandon
- Clarté
- Clairement spécifiée
- Accessibilité débutants
- 55/100