ibrahimlasfar commited on
Commit
9ec6eb1
·
1 Parent(s): 585128b

Shorten short_description to meet Hugging Face metadata requirements

Browse files
Files changed (1) hide show
  1. README.md +4 -4
README.md CHANGED
@@ -8,7 +8,7 @@ sdk_version: 0.115.0
8
  app_file: app.py
9
  pinned: false
10
  license: apache-2.0
11
- short_description: API for integrating T5 and Mistral-7B (GGUF) models in Hugging Face Spaces
12
  ---
13
 
14
  # MGZON Smart Assistant
@@ -17,14 +17,13 @@ This project provides a FastAPI-based API for integrating two language models:
17
  - **MGZON-FLAN-T5**: A pre-trained T5 model fine-tuned to respond to questions containing keywords like "mgzon", "flan", or "t5".
18
  - **Mistral-7B-GGUF**: A Mistral-7B model in GGUF format for answering general questions.
19
 
20
- ![Demo](https://huggingface.co/spaces/MGZON/api-mg/resolve/main/demo.png)
21
-
22
  ## Setup
23
  - **Docker**: The image is built using `python:3.10-slim` with development tools (`gcc`, `g++`, `cmake`, `make`) installed to support building `llama-cpp-python`.
 
24
  - **System Requirements**: Dependencies are installed from `requirements.txt`, including `transformers`, `torch`, `fastapi`, and `llama-cpp-python`.
25
  - **Model Download**: The Mistral-7B GGUF model is downloaded via `setup.sh` using `huggingface_hub`.
26
  - **Environment Variables**:
27
- - `HF_HOME` and `TRANSFORMERS_CACHE` are set to `/app/.cache/huggingface`.
28
  - `HF_TOKEN` (secret) is required to access models from the Hugging Face Hub.
29
 
30
  ## How to Run
@@ -43,3 +42,4 @@ curl -X POST "https://mgzon-api-mg.hf.space/ask" \
43
  -H "Content-Type: application/json" \
44
  -d '{"question": "What is MGZON?", "max_new_tokens": 100}'
45
  ```
 
 
8
  app_file: app.py
9
  pinned: false
10
  license: apache-2.0
11
+ short_description: API for T5 and Mistral-7B in Hugging Face Spaces
12
  ---
13
 
14
  # MGZON Smart Assistant
 
17
  - **MGZON-FLAN-T5**: A pre-trained T5 model fine-tuned to respond to questions containing keywords like "mgzon", "flan", or "t5".
18
  - **Mistral-7B-GGUF**: A Mistral-7B model in GGUF format for answering general questions.
19
 
 
 
20
  ## Setup
21
  - **Docker**: The image is built using `python:3.10-slim` with development tools (`gcc`, `g++`, `cmake`, `make`) installed to support building `llama-cpp-python`.
22
+ - **Permissions**: The application runs as a non-root user (`appuser`), with cache (`/app/.cache/huggingface`) and model (`models/`) directories configured with appropriate permissions.
23
  - **System Requirements**: Dependencies are installed from `requirements.txt`, including `transformers`, `torch`, `fastapi`, and `llama-cpp-python`.
24
  - **Model Download**: The Mistral-7B GGUF model is downloaded via `setup.sh` using `huggingface_hub`.
25
  - **Environment Variables**:
26
+ - `HF_HOME` is set to `/app/.cache/huggingface`.
27
  - `HF_TOKEN` (secret) is required to access models from the Hugging Face Hub.
28
 
29
  ## How to Run
 
42
  -H "Content-Type: application/json" \
43
  -d '{"question": "What is MGZON?", "max_new_tokens": 100}'
44
  ```
45
+