Create your own writing assistant

[lewtun]

Please read the topic category description to understand what this is all about

Description

Many email and word processing applications can now automatically detect and correct common grammatical errors as you write. For example, the sentence “I am doing fine. How is you?” might be corrected to “I am doing fine. How are you?”. The goal of this project is to fine-tune a Transformer model to be able to automatically provide these corrections, similar to how Grammarly does

Model(s)

This task can be viewed as a sequence-to-sequence task, so models like T5 would be a great starting point

Datasets

• jfleg

Challenges

If you use T5, you’ll need to define a suitable prefix for the text-to-text task. You’ll also need to think about suitable metrics for the evaluation.

Desired project outcomes

• Create a Streamlit or Gradio app on Spaces that can automatically provide suggestions to improve the grammar of some input text. Check out Grammarly for some inspiration on the visualization side.
• Don’t forget to push all your models and datasets to the Hub so others can build on them!

Additional resources

• https://towardsdatascience.com/fine-tune-a-transformer-model-for-grammar-correction-b5c8ca49cc26
• https://github.com/PrithivirajDamodaran/Gramformer

Discord channel

To chat and organise with other people interested in this project, head over to our Discord and:

• Follow the instructions on the #join-course channel
• Join the writing-assistant channel

Just make sure you comment here to indicate that you’ll be contributing to this project

Team organization on the Hub

To join this team, make sure you join the following organisation on the Hub:

• team-writing-assistant (🤗 Course Team Writing Assistant)

[Modfiededition]

Hi, I am Ashish and I am interested in this project and would like to build it.

[lewtun]

Hey @Modfiededition, great to hear that you’re interested in this project! I’ve created a Discord channel (details in the topic description) for you and others join

[Modfiededition]

Hi, I am not able to find the discord channel for this project.

[satpalsr]

Hey! I am Satpal and would be contributing to this project.

[lewtun]

Hey @Modfiededition, did you find the channel in the end? I see there is already someone called Ashish in the channel. If not, you first need to follow the instructions on the #join-course channel, which will then give you access to the project channels

[Modfiededition]

@lewtun I got the channel. Sorry, for the inconvenience.

[lewtun]

Hey @Modfiededition and @satpalsr, I’ve created an organisation on the Hub for your team so that you can push your models there and deploy your Streamlit / Gradio application

See the topic description for the link

[cahya]

Hi, I am also interested to this topic. I always wanted to know how grammarly works

[Modfiededition]

Hey! @lewtun I would like to build this project individually. So, do I need to push my model to this organisation on the Hub?

[lewtun]

Hey @Modfiededition, you’re certainly welcome to build the project by yourself

In that case, you can push the models and Space to your Hub account - just drop a link here to the Space so we can check it at the end of the event!

[Modfiededition]

hey @lewtun, please check the below screenshot. I don’t understand why I am getting this error on the Hub Inference API.
here is my hub model card link: https://huggingface.co/Modfiededition/t5-base-fine-tuned-jfleg?text=this+is+bads

[lewtun]

Hey @Modfiededition it seems that your tokenizer is somehow missing files like tokenizer.json. What happens if you run tokenizer.push_to_hub()?

[Modfiededition]

Hey @lewtun , I have successfully built the Course project: " Create your own writing assistant".

Please find below my hub model card and Space link for this project.

Hub Model Card Link: Modfiededition/t5-base-fine-tuned-on-jfleg · Hugging Face
Space Link: Writing_Assistant - a Hugging Face Space by Modfiededition

Thanks & Regards:

Ashish Goyal
Email id: ashishgy77@gmail.com

[lewtun]

This is sooo cool @Modfiededition !

It really works nicely

[Modfiededition]

Actually, I am thankful to you @lewtun and all the huggingface team members for creating this wonderful course. I am only able to build this cool project because of the course. The content is also so easy to understand and I just couldn’t stop loading pre-trained models and fine tuning them on different tasks

[lewtun]

Thank you for the very kind words @Modfiededition It’s a real pleasure to hear that the course is useful and enabling people like yourself to build these cool applications!