Skip to content

Commit f35bc17

Browse files
committed
2 parents 3a7bdf0 + 154fa2c commit f35bc17

1 file changed

Lines changed: 43 additions & 11 deletions

File tree

README.md

Lines changed: 43 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Este proyecto es una librería de Deep Learning ligera y modular desarrollada í
44

55
Está diseñada para ser escalable y educativa, permitiendo la creación de arquitecturas personalizadas para resolver problemas de clasificación binaria y regresión, como el clásico problema XOR.
66

7-
## 🚀 Características Principales
7+
## Características Principales
88
* **Arquitectura Modular:**
99
* **Diseño Orientado a Objetos:** Separación lógica entre Neuronas, Capas (`Layer`) y el Orquestador (`NeuralNetwork`).
1010
* **Activaciones Flexibles:** Implementación de funciones `Sigmoid`, `ReLU` y `LeakyReLU` intercambiables por capa.
@@ -20,21 +20,21 @@ Está diseñada para ser escalable y educativa, permitiendo la creación de arqu
2020
* **Visualización:**
2121
* Integración con `matplotlib` para generar curvas de aprendizaje y monitorear la convergencia del error en tiempo real.
2222

23-
## 🛠️ Tecnologías Utilizadas
23+
## Tecnologías Utilizadas
2424
El proyecto utiliza un stack enfocado en el cálculo numérico y la eficiencia matemática:
2525
* **Lenguaje:** Python 3.10+
2626
* **Cálculo Numérico:** NumPy (Álgebra lineal, operaciones matriciales).
2727
* **Empaquetado:** Setuptools (Estructura de librería instalable).
2828
* **Visualización:** Matplotlib (Gráficos de curvas de pérdida).
2929
* **Testing:** Unittest (Pruebas unitarias para neuronas, capas y pérdidas).
3030

31-
## 📋 Pre-requisitos
31+
## Pre-requisitos
3232
Asegúrate de tener instalado y configurado lo siguiente:
3333
* Python 3.8 o superior
3434
* Git
3535
* Virtualenv (recomendado)
3636

37-
## 🔧 Instalación y Configuración
37+
## Instalación y Configuración
3838
Sigue estos pasos para levantar el proyecto en tu entorno local:
3939

4040
1. **Clonar el repositorio:**
@@ -69,9 +69,9 @@ python -m unittest discover tests
6969
python main.py
7070
```
7171

72-
## 🔐 Uso del Sistema
72+
## Uso del Sistema
7373
La librería está diseñada para ser intuitiva. Aquí tienes un ejemplo de cómo configurar una red para clasificación:
74-
```bash
74+
```python
7575
import numpy as np
7676
from src.neural_network import NeuralNetwork
7777
from src.activations import LeakyReLU, Sigmoid
@@ -93,7 +93,42 @@ nn.train(X, y, epochs=10000, learning_rate=0.1)
9393
predicciones = nn.predict(X)
9494
```
9595

96-
## 📂 Estructura del Proyecto
96+
## Integración en Proyectos Reales (Ej. Django/Flask)
97+
98+
Gracias a que `NeuralNetwork` es un paquete instalable, puedes integrarlo fácilmente en backends web.
99+
100+
1. **Instalar la librería en tu otro proyecto:**
101+
```bash
102+
# Desde la carpeta de tu proyecto Django
103+
pip install git+[https://github.com/elJulioDev/neural_network.git](https://github.com/elJulioDev/neural_network.git)
104+
```
105+
106+
2. **Ejemplo de uso en una vista de Django (views.py):**
107+
```python
108+
from django.http import JsonResponse
109+
from neural_network import NeuralNetwork
110+
import numpy as np
111+
import os
112+
113+
# Cargar el modelo entrenado (Singleton recomendado para producción)
114+
MODEL_PATH = os.path.join(os.path.dirname(__file__), 'modelos', 'xor_model.pkl')
115+
ai_model = NeuralNetwork.load_model(MODEL_PATH)
116+
117+
def predecir_view(request):
118+
# Suponiendo que recibes datos [0, 1]
119+
datos_entrada = np.array([[0, 1]])
120+
121+
# Realizar inferencia
122+
prediccion = ai_model.predict(datos_entrada)
123+
124+
return JsonResponse({
125+
'input': [0, 1],
126+
'prediccion': float(prediccion[0][0]),
127+
'clase': 1 if prediccion > 0.5 else 0
128+
})
129+
```
130+
131+
## Estructura del Proyecto
97132
```text
98133
neural_network/
99134
├── src/ # Código fuente de la librería
@@ -114,8 +149,5 @@ neural_network/
114149
└── .gitignore # Archivos ignorados
115150
```
116151

117-
## 👥 Créditos
118-
Este proyecto ha sido desarrollado por **Alexis González** como parte de una investigación profunda sobre los fundamentos matemáticos de la Inteligencia Artificial.
119-
120-
## 📄 Licencia
152+
## Licencia
121153
Este proyecto es de uso educativo y personal. Se distribuye bajo la licencia MIT.

0 commit comments

Comments
 (0)