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

Potential Community Contribution to the knowledge base: Bio-image Analysis Notebooks #150

Open
haesleinhuepf opened this issue Aug 12, 2024 · 3 comments

Comments

@haesleinhuepf
Copy link

Hi all,

I am considering making a community contribution to your project if you are interested. I maintain the Bio-image Analysis Notebooks, a collection of Jupyter notebooks demonstrating how to analyse microscopy images using Python. These notebooks serve as knowledge base for the BioImage Analysis GPT. If you are interested, I could serve this knowledge base to you (in whatever format you require) and you could make it part of the BioImage-IO ChatBot knowledge base. The only thing I would kindly ask you to is to respect the CC-BY license under which the notebooks are licensed:

Let me know if this sounds interesting to you!

Best,
Robert

@oeway
Copy link
Contributor

oeway commented Aug 13, 2024

Thank you for the offer—we'd be happy to include your Bio-image Analysis Notebooks in the BioImage-IO ChatBot knowledge base. Of course, we'll provide proper attribution as required by the CC-BY license. As you can see in our recent PR, we're actively improving reference and author attribution in the chat interface based on your previous comments.

The easiest is to send a PR to add a new entry to the manifest file pointing to a Github folder with the notebooks rendered in markdown (if that's possible), the content will be injected once we rebuild the knowledge base. Maybe wait a bit on #149 so you know how to add author license information.

@haesleinhuepf
Copy link
Author

Awesome!

notebooks rendered in markdown (if that's possible)

I think I have seen others converting ipynb files into myst markdown files... But before I start researching how to do this: Have you done this before? If there's a conversion script I could reuse, that would be great. Otherwise, I'll write it.

Thanks again!

@oeway
Copy link
Contributor

oeway commented Aug 14, 2024

I think I have seen others converting ipynb files into myst markdown files... But before I start researching how to do this: Have you done this before? If there's a conversion script I could reuse, that would be great. Otherwise, I'll write it.

Thanks!

No, we don't have it yet, but i believe you can do it with something like nbconvert.

I guess the best is to add a CI script so we can publish markdown content automatically to a github branch, then we just need to point to it.

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

No branches or pull requests

2 participants