From 1e19c6f9857cb08e870857580d8083687e6f9851 Mon Sep 17 00:00:00 2001
From: BIRK Renaud <renaud.birk@imt-atlantique.net>
Date: Sun, 9 Mar 2025 11:31:27 +0100
Subject: [PATCH] doc: HuggingFace configuration

---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/README.md b/README.md
index 713da32..227a8e1 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,19 @@ Then, use the included scripts to install Archi Back:
 chmod +x ./setup.sh && ./setup.sh
 ```
 
+## Configuration
+
+The back-end part send requests to the HuggingFace API.
+
+Follow these steps to connect your account to the back-end:
+
+1. Visit [this page](https://huggingface.co/settings/tokens/new?tokenType=read)
+   to create a new token (give it a name).
+2. When your token is created, you should see its value. Copy the value in
+   `.env` file (replace `hf_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX` with your token,
+   make sure to keep `hf_token=` before!)
+3. Your back-end should now be linked to your HuggingFace account.
+
 ## Usage
 
 First, you should launch the back-end part:
-- 
GitLab