Hugging-Face-Transformers-Glossary-Flashcards

Repository containing Anki Flashcards & source code to revise Hugging Face's transformers terms

Introduction

This repository has taken definitions outlined in Hugging Face's Transformers Glossary and put them into a form which can be easily learnt/revised using Anki a cross platform app specifically designed for long term knowledge retention.

Notes

Please note the modifications which have been made & where you can find updates.

1. The front of every card has "(Hugging Face Transformers Glossary)" appended to the end so that if you have any other words in your collection, the Hugging Face's Glossary definition will still be added when importing it.
2. The original relative URLs have been made into full URLs so they are clickable within Anki.
3. Unordered lists have been aligned to the left to make them easier to read in Anki which automatically centers content.
4. Any updates, translations or corrections to the deck will be available at https://github.com/darigovresearch/Hugging-Face-Transformers-Glossary-Flashcards so do return periodically to check if you have the latest version.

Feel free to share the deck and give the repository a star so more people are likely to see this work and can get the most out of it.

Usage

If you want to just learn the words, download Anki on your device of choice and open the .apkg file to add it into your collection. If you wish to build the deck from scratch you will need to import the .csv file via the desktop with HTML enabled and the separator to be "|".

Watch our video on an Introduction to Anki for a complete overview -> https://www.youtube.com/watch?v=Dji_h7PILrw

Potential improvements yet to be made

1. To find a way to systematically pull the definitions from the glossary so that any corrections or additions are automatically updated.
2. To be able to automatically sort the cards so that the words which are used most in the glossary (or the documentation as a whole) is displayed first for the user to learn.
3. To translate the deck into different languages so people around the world can learn about the topic. All translations will be found in the link above & we are happy to incorporate any translations that have been submitted.

Contributing

Pull requests, corrections, translations & fixes are welcome. Any contributions must be submitted under the same license as the original piece of work (see below). Take a look at any open issues or submit new ones if there is something that needs to be fixed or added.

Watch our video on how to contribute to open source for a complete overview -> https://www.youtube.com/watch?v=UWA4wyacY2A

Translating for other languages

Translations in all languages are welcome. Send a pull request or open an issue any time of day or night.

Please prepend the tag [lang-code] to your issues and pull requests. For example, [fr] for French. This will help everyone pick out things they care about.

We're happy for any contribution in any form, but if you're making more than one major change (i.e. translations for two different languages) it would be super cool of you to make a separate pull request for each one so that someone can review them more effectively and/or individually.

License

Unless otherwise specified, everything in this repository is covered by the following licence:

This work was based on the Hugging Face's Transformers Glossary by Hugging Face. Content is available under an Apache 2.0 license.

To see this work in full go to https://huggingface.co/transformers/glossary.html

---

The creation, maintenance and continued development of this project is made possible
thanks to our Patreon and Direct supporters!
Consider joining them if you think this project has earned it!