Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: progress-bar-dockstring #1254

Closed
wants to merge 3 commits into from

Conversation

ictorv
Copy link
Contributor

@ictorv ictorv commented Jan 29, 2025

Related to issue #1252 @glemaitre

@thomass-dev
Copy link
Collaborator

thomass-dev commented Jan 29, 2025

Can you please run the tests on skore/src/ using pytest, to see which doctests should be updated?

@ictorv
Copy link
Contributor Author

ictorv commented Jan 29, 2025

Can you please run the tests on skore/src/ using pytest, to see which doctests should be updated?

Yeah checking

@ictorv
Copy link
Contributor Author

ictorv commented Jan 29, 2025

Can you please run the tests on skore/src/ using pytest, to see which doctests should be updated?

@thomass-dev These many tests are failing
pr

@thomass-dev
Copy link
Collaborator

thomass-dev commented Jan 29, 2025

You need to fix everywhere the doctest failled.

For instance, in skore/src/skore/sklearn/_cross_validation/report.py, the Processing cross-validation ... line must be removed, because with your changes, the progress bar disappears after completion.

Examples                                                              
--------                                                              
>>> from sklearn.datasets import make_classification                  
>>> from sklearn.model_selection import train_test_split              
>>> from sklearn.linear_model import LogisticRegression               
>>> X, y = make_classification(random_state=42)                       
>>> estimator = LogisticRegression()                                  
>>> from skore import CrossValidationReport                           
>>> report = CrossValidationReport(estimator, X=X, y=y, cv_splitter=2)
Processing cross-validation ...  <~~ to remove
"""

Check for this pipeline https://github.com/probabl-ai/skore/actions/runs/13035989062/job/36367544164?pr=1254.

@thomass-dev thomass-dev mentioned this pull request Jan 29, 2025
Copy link
Contributor

Documentation preview @ 6c2c5f3

@ictorv
Copy link
Contributor Author

ictorv commented Jan 29, 2025

You need to fix everywhere the doctest failled. For instance, in skore/src/skore/sklearn/_cross_validation/report.py, the Processing cross-validation ... line must be removed, because with your changes, the progress bar disappears after completion.

Examples                                                              
--------                                                              
>>> from sklearn.datasets import make_classification                  
>>> from sklearn.model_selection import train_test_split              
>>> from sklearn.linear_model import LogisticRegression               
>>> X, y = make_classification(random_state=42)                       
>>> estimator = LogisticRegression()                                  
>>> from skore import CrossValidationReport                           
>>> report = CrossValidationReport(estimator, X=X, y=y, cv_splitter=2)
Processing cross-validation ...  <~~ to remove
"""

Check for this pipeline https://github.com/probabl-ai/skore/actions/runs/13035989062/job/36367544164?pr=1254.

So should I remove Processing cross-validation ... from dockstring everywhere and test? Or do some code,
since it is showing DocTestFailure ?

EDIT: Got it changing

@glemaitre
Copy link
Member

Closing in favor of #1255

@glemaitre glemaitre closed this Jan 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants