How to ask questions on the forum?

Hi there and welcome on the HuggingFace forums!

Here are a few guidelines before you make your first post, but the goal is to create a wide discussion space with the NLP community, so don’t hesitate to break them if you feel they are too rigid. First, let’s have a look at the categories available.

Categories

The Beginners category is primarily intended for beginners (as you may have guessed from its name). Any question on any of the :hugs: libraries is welcome there, be it to debug some code or to ask for help about how to do something. That being said, if your question is only linked to one library in particular, you should probably head to the corresponding category on this forum.This category and the intermediate category are horizontal and more suited to problems that involve several :hugs: libraries.

The Intermediate category is for more advanced questions, for sharing your projects using any of the :hugs: libraries with the community, or to get help building them, coordinate with other users.

The Research category is where you would discuss the latest NLP paper. It also contains the awesome papers subcategory, which groups the interesting articles the Hugging Face team reviewed and commented during their Science Tuesdays.

Once you have selected your category, you should be ready to write you first topic.

Writing a new topic

Before writing a new topic, make sure there is not already one that addresses the same subject by doing a quick search. Discourse uses Markdown to format your posts, here is quick introduction that should get you started. Whenever you write a post, you get a preview in the window on the left.

When writing a post or replying to someone, remember to be friendly with other users. You can read more on this on the FAQ. In general, avoid tagging a person (especially the moderators or the admins) unless that person is really the only one that can help you.

Also remember that other users can’t read your thoughts. That means you should always show the code you’re trying when asking for help to debug something (see below) or the link to the paper you are referencing. In general, always provide all the necessary information so that others can easily help you and engage with you.

Getting help with an error

When trying to get help with an error, it’s very important to include as the following information:

  • First post all the code that leads to the problem. People will only be able to help you if they can reproduce your error. To format it properly in Markdown, place it between two lines containing ```.
  • Then copy the full error message. It may seem cryptic to you but it may contain something that another user will instantly recognize. Again, to format it properly in Markdown, place it between two lines containing ```.
  • Provide the version of the library you are using. For instance :hugs:Transformers has a command transformers-cli env you can type that returns details of your system installation.
  • If you have tried something in particular to solve your problem, don’t hesitate to mention it as well.

This may seem tedious but this is what will make the difference between a post that might be ignored and one that receives an answer in a a couple of hours.

9 Likes