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

Translation to Portuguese-Brazil #173

Open
11 of 51 tasks
rrg92 opened this issue Mar 23, 2024 · 2 comments
Open
11 of 51 tasks

Translation to Portuguese-Brazil #173

rrg92 opened this issue Mar 23, 2024 · 2 comments

Comments

@rrg92
Copy link

rrg92 commented Mar 23, 2024

Hi there 👋

Let's translate the course to pt-BR so that the whole community can benefit from this resource 🌎!

Below are the chapters and files that need translating - let us know here if you'd like to translate any and we'll add your name to the list. Once you're finished, open a pull request and tag this issue by including #issue-number in the description, where issue-number is the number of this issue.

🙋 If you'd like others to help you with the translation, you can also post in our forums or tag @_lewtun on Twitter to gain some visibility.

Chapters

** TOC **

Unit 0 - Welcome to the course!

Unit 1 - Working with audio data

Unit 2 - A gentle introduction to audio applications

Unit 3 - Transformer architectures for audio

Unit 4 - Build a music genre classifier

Unit 5 - Automatic Speech Recognition

  • [`introduction

.mdx`](https://github.com/rrg92/audio-transformers-course/blob/main/chapters/pt-BR/chapter5/introduction.mdx)

Unit 6 - From text to speech

Unit 7 - Putting it all together

Unit 8 - Finish line

Course Events


@rrg92
Copy link
Author

rrg92 commented Mar 30, 2024

I encountered some difficulties when attempting to use the preview feature, as outlined in the README and on the hf-doc-builder repository page.

Initially, I tried installing hf-doc-builder with the command pip install hf-doc-builder, which unfortunately led to a 404 error when executing the doc-builder preview command. I also tried directly installing a specific version with pip install hf-doc-builder==0.4.0, but this approach also resulted in the same errors.

However, this method also proved unsuccessful, leading to the same complications. Beyond the primary issue of encountering a 404 error when attempting to execute the doc-builder preview command, I observed an additional peculiarity: the service was listening on port 5173. This detail was particularly perplexing because the documentation explicitly states that the correct listening port should be 3000. Interestingly, when I adopted the alternative approach of cloning the hf-doc-builder from its source and installing it from there, not only did it resolve the 404 error, but it also corrected the port discrepancy, with the service now correctly listening on port 3000 as prescribed by the documentation. This leads me to speculate that the unexpected behavior, including the service defaulting to port 5173, might be tied to specific versioning issues inherent in the package installed via the conventional pip method.

To successfully use the preview feature, I found it necessary to directly clone the hf-doc-builder from its source at https://github.com/huggingface/hf-doc-builder. After cloning, I switched to the tag for version 0.4.0 and installed it from the sources using pip install -e .. Following these steps, the preview functioned as expected, notably using port 3000. This workaround seems to bypass the issue associated with the default installation methods, which seem to direct the service to an unintended port.

@rrg92
Copy link
Author

rrg92 commented Mar 30, 2024

Upon further investigation, I uncovered the root cause of the issues I was experiencing with the preview feature of the hf-doc-builder package. The crux of the problem lies in how the doc-builder project locates a folder named "kit." This folder is pivotal as it contains the Node.js code that doc-builder is designed to invoke.

The operational logic embedded within doc-builder is quite specific: if the current working directory is recognized as a Git repository and contains a folder named "kit," doc-builder opts to utilize this folder. Therefore, when cloning the repository and switching to tag v0.4.0, doc-builder correctly identifies and uses the "kit" folder that is tailored for that version.

Contrastingly, the situation diverges when doc-builder is installed via pip. In this scenario, the "kit" folder is absent from the installation, which triggers a fallback mechanism within the utility logic, coded in utils.js. This mechanism attempts to clone the https://github.com/huggingface/hf-doc-builder repository and subsequently copy over the "kit" folder. However, this cloned version contains a "kit" folder designed for a version distinct from the one intended, leading to compatibility issues and errors. This discrepancy elucidates why installation directly from the repository for version 0.4.0 circumvents these problems.

Moreover, a closer examination of the contents within the "kit" folder reveals significant changes, likely introduced between versions 0.4.0 and 0.5.0. These alterations could be the underlying cause of the 404 errors encountered during preview attempts. It appears that these version-specific changes to the "kit" folder's structure or its contents are not compatible with certain versions of the doc-builder, thus necessitating the direct installation from the source for the intended version to ensure functionality and compatibility. This insight not only resolves the initial quandary but also underscores the importance of version alignment between the doc-builder and its dependent "kit" folder for seamless operation.

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

1 participant