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

Add JavaScript tutorial to the docs #271

Merged
merged 54 commits into from
Sep 17, 2023
Merged

Add JavaScript tutorial to the docs #271

merged 54 commits into from
Sep 17, 2023

Conversation

perborgen
Copy link
Contributor

This PR adds a tutorial on Image Object Detection using vanilla JavaScript. It's meant as the entry point for newbie devs who might struggle with the React/Next/Node examples. It requires no setup or build tools to run, simply drag&drop the file into the browser.

@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Aug 31, 2023

The documentation is not available anymore as the PR was closed or merged.

@kungfooman
Copy link
Contributor

  1. The code is a mixture of spaces and tabs
  2. Mixture of semicolons and lack thereof
  3. Using jsx tags for JavaScript - any advantage over simply js?

But nice job 👍 🥇

@perborgen perborgen marked this pull request as draft August 31, 2023 14:24
@perborgen
Copy link
Contributor Author

Thanks @kungfooman!

I've changed it to 4 spaces for the indentation, and removed the jsx snippets. Not sure why they were there, probably just from Notion.

Also added semi colons :)

@perborgen perborgen marked this pull request as ready for review August 31, 2023 14:43
@kungfooman
Copy link
Contributor

I just love standalone examples, just pressing . while viewing your fork, GitHub editor opens, right click on the examples dir and download only one folder for some quick testing 👍

image

That armor is a 🍰 ... I wonder if we could also make a tutorial about fine-tuning 😂 Nice work 🚀

@xenova
Copy link
Collaborator

xenova commented Aug 31, 2023

Thanks so much @perborgen! 😍 This is great! I'll review the whole thing soon. 🤗

Copy link
Collaborator

@xenova xenova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a game changer! I absolutely love the scrim too - very engaging and interactive.

I've left a few notes about things we can change, but what will probably be easiest (and quickest for me to review) is if you can grant me write access to your fork (https://github.com/perborgen/transformers.js).

Looking forward to getting this merged - thanks so much for your work!

docs/snippets/3_examples.snippet Outdated Show resolved Hide resolved
docs/source/tutorials/javascript.md Outdated Show resolved Hide resolved
docs/source/tutorials/javascript.md Outdated Show resolved Hide resolved
examples/javascript-object-detection/upload-icon.png Outdated Show resolved Hide resolved
examples/javascript-object-detection/utils.js Outdated Show resolved Hide resolved
examples/javascript-object-detection/index.js Outdated Show resolved Hide resolved
examples/javascript-object-detection/index.js Outdated Show resolved Hide resolved
examples/javascript-object-detection/index.js Outdated Show resolved Hide resolved
@perborgen
Copy link
Contributor Author

Thanks for the review @xenova ! Just invited you to my fork so that you can make apply changes directly. Once I see how the final source code looks like, I'll record a new scrim :)

@xenova
Copy link
Collaborator

xenova commented Sep 16, 2023

I've just been proof-reading and improving some of the sections (mainly just trying to keep some terms consistent across the docs). I'll continue with step 4 and the rest tomorrow.

Copy link
Collaborator

@xenova xenova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to go!

@xenova xenova merged commit ef27100 into huggingface:main Sep 17, 2023
4 checks passed
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

Successfully merging this pull request may close these issues.

4 participants