cookbook icon indicating copy to clipboard operation
cookbook copied to clipboard

Call for Contributions

Open merveenoyan opened this issue 1 year ago β€’ 15 comments

Hello folks! πŸ™‹β€β™€οΈ Wanted to post here the roadmap we have for the cookbook. The cookbook is made for industry/applied AI use cases. In the upcoming weeks, we would like to have more recipes on the following topics:

  • Industry-specific recipes: domains like biomedical, legal, finance, and so on require know-how in handling data and the model. You can either contribute an end-to-end Hugging Face example with domain-specific data (can be NLP, computer vision, anything) or demonstrate your library.
  • Use cases in other domains: are missing, such as computer vision, multimodal and more. Would be great to have more notebooks.
  • Niche techniques built for production: Such as making model faster for real-time prediction with quantization/optimization, or data privacy preservation techniques like federated learning.

In all of above, you can either do Hugging Face e2e workflows or demonstrate your own library or any library you'd like to use.

Feel free to let us know or open a discussion or issue here if you have ideas and you'd like to validate ☺️

merveenoyan avatar Apr 24 '24 14:04 merveenoyan

I can help about how to fine-tune a Vision Transformer model with a custom biomedical dataset. I made an example for my graduation project.

emre570 avatar Apr 24 '24 20:04 emre570

@merveenoyan I will be contributing one in computer vision shortly πŸ˜‰

jacobmarks avatar Apr 25 '24 01:04 jacobmarks

We work on high-throughput and real-time hematology analysis for clinical diagnostics, therefore, I have experience on and can contribute to end-to-end vision and data processing pipelines including image acquisition and pre-processing, image reconstruction and object detection/segmentation.

krmdel avatar Apr 25 '24 07:04 krmdel

@krmdel that sounds great tbh!

merveenoyan avatar Apr 25 '24 08:04 merveenoyan

@jacobmarks @emre570 awesome, awaiting your PRs!!!

merveenoyan avatar Apr 25 '24 08:04 merveenoyan

@jacobmarks @emre570 awesome, awaiting your PRs!!!

Thanks @merveenoyan , contribution ready for review :) https://github.com/huggingface/cookbook/pull/89.

Do you accept multiple contributions from the same person if they are on different topics and don't overlap in concepts/recipes?

jacobmarks avatar May 03 '24 19:05 jacobmarks

@jacobmarks I think it makes sense to have one example per library for instance unless it shows a very solid industry use case with great know-hows, but I'd like to defer to @stevhliu

merveenoyan avatar May 07 '24 11:05 merveenoyan

Hi, @jacobmarks, as long as the recipes are practical and demonstrate a real-world application, feel free to contribute as many recipes as you'd like. There is no limit to how many recipes you can contribute πŸ™‚

Bonus points if the recipe is industry-specific, applicable to non-text domains like computer vision, or specialized techniques for production!

stevhliu avatar May 07 '24 15:05 stevhliu

Is it possible to add a notebook in English only? One of our team member created a notebook on 'How to use the Hugging Face Inference Endpoint to host models in the Hub and implement an end-to-end RAG pipeline based on open models', and I think it would be great to contribute it to the cookbook.

jungnerd avatar Jun 16 '24 15:06 jungnerd

Sure! You can open a PR to add the notebook to cookbook/notebook/en πŸ™‚

stevhliu avatar Jun 17 '24 16:06 stevhliu

Sure! You can open a PR to add the notebook to cookbook/notebook/en πŸ™‚

The notebook is written in Korean, is that okay? πŸ€”

jungnerd avatar Jun 18 '24 02:06 jungnerd

Oh sorry, I misunderstood your message! Would you like to create cookbook/notebook/ko and add the notebook there?

stevhliu avatar Jun 18 '24 17:06 stevhliu

Oh sorry, I misunderstood your message! Would you like to create cookbook/notebook/ko and add the notebook there?

Oh that would be great if we could! We'll be creating more notebooks as team projects soon, and it would be nice to have cookbook/notebook/ko folder πŸ‘

jungnerd avatar Jun 20 '24 01:06 jungnerd

Hi! I'd like to contribute with an Fine-tuning and object detection model cookbook example. I already have a draft that I can upload as a PR πŸ˜„. In the notebook, I fine-tune an object detection model from the hub on a dataset also from the hub and we upload the result.

sergiopaniego avatar Aug 13 '24 15:08 sergiopaniego

Thanks, feel free to open a PR so we can take a look! Bonus points if it's an object detection model trained for an industry-specific use case πŸ˜„

stevhliu avatar Aug 13 '24 16:08 stevhliu