tecuhtli commited on
Commit
1ea490a
·
verified ·
1 Parent(s): c6290d6

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +37 -100
README.md CHANGED
@@ -1,100 +1,37 @@
1
- # 🧠 Mori: Your Friendly Data Science Assistant
2
-
3
- **Mori** is a conversational assistant trained to answer questions about data science, AI concepts, and related topics.
4
- It uses a dual-response system: one technical model and one social model, allowing it to switch between factual answers and casual interactions.
5
-
6
- ---
7
-
8
- # Instalación
9
-
10
- ## Entorno recomendado
11
-
12
- Crea y activa un entorno virtual para aislar dependencias. Se recomienda usar la carpeta en la **raíz del proyecto** (ej. `.venv`):
13
-
14
- ```bash
15
- # Windows (PowerShell)
16
- python -m venv .venv
17
- .\.venv\Scripts\Activate.ps1
18
-
19
- # Windows (CMD)
20
- python -m venv .venv
21
- .\.venv\Scripts\activate.bat
22
-
23
- # macOS / Linux (bash/zsh)
24
- python3 -m venv .venv
25
- source .venv/bin/activate
26
- ```
27
-
28
- ## Requisitos
29
- - **Python** 3.10
30
- - (Opcional, GPU) **NVIDIA Driver** actualizado
31
- - (Opcional) **CUDA/cuDNN** a nivel sistema **solo si los necesitas**.
32
- > Si instalas PyTorch con un wheel que ya incluye CUDA (p. ej., `cu118`), no requieres el toolkit local; basta con el **driver**:
33
- - pip3 install torch --index-url https://download.pytorch.org/whl/cu118
34
-
35
- ## Instalación (GPU)
36
-
37
- - python -m pip install --upgrade pip
38
- - pip install torch --index-url https://download.pytorch.org/whl/cuXXX
39
- - pip install -r requirements.txt
40
-
41
- ## Instalación (CPU)
42
-
43
- - python -m pip install --upgrade pip
44
- - pip install torch --index-url https://download.pytorch.org/whl/cpu
45
- - pip install -r requirements.txt
46
-
47
-
48
- # Uso
49
-
50
- ***Es necesario utilizar el siguiente comando:***
51
-
52
- - streamlit run app.py --server.port=8501 --server.address=0.0.0.0
53
-
54
- ## 🚀 Try it out!
55
-
56
- Just type your question in the input box and let Mori guide you!
57
- You can ask things like:
58
- - *What is overfitting?*
59
- - *Can you explain PCA?*
60
- - *Tell me a data science joke!*
61
- - *I'm feeling tired...*
62
-
63
- ---
64
-
65
- ## 🛠️ How it works
66
-
67
- Mori is powered by two custom fine-tuned models based on the T5 architecture:
68
- - `Mori Técnico`: answers technical questions about data science and machine learning
69
- - `Mori Social`: replies in a friendly, supportive tone for casual conversation
70
-
71
- It uses **Streamlit** for the interface and **Hugging Face Transformers** to load and run the models.
72
-
73
- ---
74
-
75
- ## 📁 Project structure
76
-
77
- . ├── app.py # Streamlit app ├── requirements.txt # Required packages ├── Models/ # Fine-tuned models (Técnico + Social) └── Statistics/ # Logs generated on user interaction (not persistent)
78
-
79
-
80
- ---
81
-
82
- ## 📊 Logging
83
-
84
- All interactions are logged locally in the `Statistics/` folder as `.csv` and `.jsonl` files.
85
- *Note: Hugging Face Spaces do not persist these files between restarts.*
86
-
87
- ---
88
-
89
- ## 👤 Author
90
-
91
- Created by **[hazutecuhtli](https://huggingface.co/hazutecuhtli)**
92
- PhD in Electronic Engineering, passionate about data, modeling, and sharing knowledge.
93
-
94
- ---
95
-
96
- ## 💡 Future Plans
97
-
98
- - Add model explanation outputs
99
- - Enable user-uploaded datasets
100
- - Connect logs to Google Sheets for persistent stats
 
1
+ ---
2
+ title: Mori – Asistente Técnico (Procesamiento de Datos)
3
+ emoji: 🤖
4
+ colorFrom: indigo
5
+ colorTo: green
6
+ sdk: streamlit
7
+ sdk_version: "1.38.0"
8
+ app_file: mori_tech_only.py
9
+ pinned: false
10
+ license: mit
11
+ ---
12
+
13
+ # 🧠 Mori: Your Friendly Data Science Assistant
14
+
15
+ **Mori** is a conversational assistant trained to answer questions about data science, AI concepts, and related topics.
16
+ It now runs **tech-only**: just the technical model + optional RAG (FAISS on HF), no social model, no classifier.
17
+
18
+ ---
19
+
20
+ ## Instalación
21
+
22
+ ### Entorno recomendado
23
+
24
+ Crea y activa un entorno virtual para aislar dependencias:
25
+
26
+ ```bash
27
+ # Windows (PowerShell)
28
+ python -m venv .venv
29
+ .\.venv\Scripts\Activate.ps1
30
+
31
+ # Windows (CMD)
32
+ python -m venv .venv
33
+ .\.venv\Scripts\activate.bat
34
+
35
+ # macOS / Linux (bash/zsh)
36
+ python3 -m venv .venv
37
+ source .venv/bin/activate