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

Readme should have usage snippet #22

Closed
fkiraly opened this issue Sep 13, 2024 · 2 comments
Closed

Readme should have usage snippet #22

fkiraly opened this issue Sep 13, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@fkiraly
Copy link

fkiraly commented Sep 13, 2024

I would strongly suggest, the readme should have a usage vignette, e.g.,

from rolch.model import Foo
from rolch.data import load_bar
from rolch.prettyplot import veryprettyplot

X, y, X1, y1, X2, y2 = load_bar()
m = Foo()
m.fit(X, y)
y_pred = m.predict(X1)
m.update(X1, y1)
y_pred2 = m.predict(X2)

veryprettyplot(everything)
@simon-hirsch
Copy link
Owner

simon-hirsch commented Sep 13, 2024

Good point!
Note to self: keep in mind for #21

@simon-hirsch simon-hirsch added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 15, 2024
@BerriJ
Copy link
Collaborator

BerriJ commented Sep 17, 2024

This was implemented in #21

@BerriJ BerriJ closed this as completed Sep 17, 2024
@simon-hirsch simon-hirsch self-assigned this Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants