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

Have permanent repos on the hub representing the results of our examples #159

Open
adrinjalali opened this issue Sep 29, 2022 · 7 comments
Labels
documentation Improvements or additions to documentation

Comments

@adrinjalali
Copy link
Member

adrinjalali commented Sep 29, 2022

Our examples in docs push to temporary repos, which means we can't have a link at the end to refer users to the generated repositories.

We can't push to permanent ones from the docs since we have our keys exposed there, so we should have more like a cron job which pushes to a permanent repo.

We probably need one repo for each version of the package, and have a way to link to those repositories from the docs.

For example, it would be nice to have the result of our model card example to be somewhere on the hub.

@merveenoyan you might be interested in this.

@ketangangal
Copy link

can i take this issue ?

@BenjaminBossan
Copy link
Collaborator

@ketangangal It's certainly possible, though depending on the solution, it might require some support from us maintainers (like adding secrets to the repo). What would be your approach to tackle this?

@merveenoyan
Copy link
Collaborator

This is already done no? I did it at least for our kaggle examples.
For the rest, maybe we could write a GHAction to automate it.

@ketangangal
Copy link

Please @merveenoyan let me know, If i can do something ! I am new to open-source want to make some contribution to skops.

@adrinjalali
Copy link
Member Author

I don't think it's done. We have examples which we manually have created on the hub, and they're not updated when we update examples on the repo and our docs.

This is not an easy task or a good first issue. This is about pushing the results of the examples we have to the hub, and have a link to the repo on the documentation under the examples. It involves a bit of work.

@merveenoyan
Copy link
Collaborator

@adrinjalali I think I can try and write a GH Action, open a repository and push and then we can clean up we can push. WDYT?

@adrinjalali
Copy link
Member Author

@merveenoyan that sounds like the right approach to me.

@adrinjalali adrinjalali added the documentation Improvements or additions to documentation label Jan 24, 2023
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
Projects
None yet
Development

No branches or pull requests

4 participants