DeepDream / README.md
AmirArmaniya's picture
fix readme 2
b9593b0
---
title: DeepDream Interpreter
emoji: 🔮
colorFrom: indigo
colorTo: blue
sdk: gradio
app_file: app.py
pinned: false
---
# English:
# Smart Dream Interpreter (Morphius) 🔮
[![Hugging Face Spaces](https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Spaces-blue)](https://huggingface.co/spaces/YOUR_USERNAME/YOUR_SPACE_NAME)
A simple and creative web application for dream interpretation and analysis using the power of artificial intelligence. The project allows users to enter their dream text and receive a poetic and psychological interpretation based on symbols.
![Screenshot of the application interface](https://example.com/screenshot.png) ## ✨ Features
* **Simple and beautiful user interface:** Built with `Gradio` for a smooth user experience.
* **Powerful AI engine:** Using the advanced `google/gemma-2-27b-it` model via the free OpenRouter API.
* **Personalized:** The AI ​​model appears as an ancient and wise dream interpreter named "Morpheus".
* **Ready to deploy:** Easily and for free to deploy in Hugging Face Spaces.
## 🛠️ Technologies Used
* **User Interface:** [Gradio](https://www.gradio.app/)
* **AI Model:** [Google Gemma 2 27B IT](https://openrouter.ai/models/google/gemma-2-27b-it)
* **API Provider:** [OpenRouter](https://openrouter.ai/)
* **Deployment Platform:** [Hugging Face Spaces](https://huggingface.co/spaces)
## 🚀 Setup and Run Locally
To run this project on your personal system, follow these steps:
1. **Clone the repository:**
```bash
git clone [https://github.com/YOUR_USERNAME/dream-interpreter.git](https://github.com/YOUR_USERNAME/dream-interpreter.git)
cd dream-interpreter
```
2. **Install Prerequisites:**
It is recommended to use a virtual environment.
```bash
python -m venv venv
source venv/bin/activate # On Windows use `venv\Scripts\activate`
pip install -r requirements.txt
```
3. **Set up your API key:**
* Create an account on [OpenRouter.ai](https://openrouter.ai/) and get an API key.
* Create a file called `.env` in the root of your project and put your key in it:
```
OPENROUTER_API_KEY="sk-or-..."
```
* The `app.py` file is written to read this variable automatically.
4. **Run the program:**
```bash
gradio app.py
```
Now you can view the application in your browser at `http://127.0.0.1:7860`.
## ☁️ Deploying to Hugging Face Spaces
This project is optimized for deployment to Spaces:
1. Create a new Space of type **Gradio SDK** in Hugging Face.
2. Upload the `app.py` and `requirements.txt` files to it.
3. Go to **Settings > Secrets** and create a new Secret named `OPENROUTER_API_KEY` and the value of your API key.
4. Space will automatically build and run the application.
## 🤝 Contributions
Any contributions, bug reports, or suggestions for improving the project are welcome. Please open an Issue or submit a Pull Request.
## 📄 License
This project is released under the Apache License.
-------------------------------------------------------------------------
# persian
# مفسر خواب هوشمند (Morphius) 🔮
[![Hugging Face Spaces](https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Spaces-blue)](https://huggingface.co/spaces/YOUR_USERNAME/YOUR_SPACE_NAME)
یک وب اپلیکیشن ساده و خلاقانه برای تعبیر و تحلیل خواب با استفاده از قدرت هوش مصنوعی. این پروژه به کاربران اجازه می‌دهد تا متن خواب خود را وارد کرده و تفسیری شاعرانه و روانشناسانه بر اساس نمادها دریافت کنند.
![تصویری از رابط کاربری برنامه](https://example.com/screenshot.png) ## ✨ ویژگی‌ها
* **رابط کاربری ساده و زیبا:** ساخته شده با `Gradio` برای تجربه کاربری روان.
* **موتور هوش مصنوعی قدرتمند:** استفاده از مدل پیشرفته `google/gemma-2-27b-it` از طریق API رایگان OpenRouter.
* **شخصیت‌پردازی شده:** مدل هوش مصنوعی در نقش یک مفسر خواب باستانی و خردمند به نام "مورفیوس" ظاهر می‌شود.
* **آماده استقرار:** به راحتی و به صورت رایگان در Hugging Face Spaces قابل استقرار است.
## 🛠️ تکنولوژی‌های استفاده شده
* **رابط کاربری:** [Gradio](https://www.gradio.app/)
* **مدل هوش مصنوعی:** [Google Gemma 2 27B IT](https://openrouter.ai/models/google/gemma-2-27b-it)
* **ارائه دهنده API:** [OpenRouter](https://openrouter.ai/)
* **پلتفرم استقرار:** [Hugging Face Spaces](https://huggingface.co/spaces)
## 🚀 راه‌اندازی و اجرا به صورت محلی (Local)
برای اجرای این پروژه روی سیستم شخصی خود، مراحل زیر را دنبال کنید:
1. **کلون کردن ریپازیتوری:**
```bash
git clone [https://github.com/YOUR_USERNAME/dream-interpreter.git](https://github.com/YOUR_USERNAME/dream-interpreter.git)
cd dream-interpreter
```
2. **نصب پیش‌نیازها:**
توصیه می‌شود از یک محیط مجازی (virtual environment) استفاده کنید.
```bash
python -m venv venv
source venv/bin/activate # On Windows use `venv\Scripts\activate`
pip install -r requirements.txt
```
3. **تنظیم کلید API:**
* یک حساب کاربری در [OpenRouter.ai](https://openrouter.ai/) بسازید و یک کلید API دریافت کنید.
* یک فایل به نام `.env` در ریشه پروژه بسازید و کلید خود را در آن قرار دهید:
```
OPENROUTER_API_KEY="sk-or-..."
```
* فایل `app.py` طوری نوشته شده که این متغیر را به صورت خودکار بخواند.
4. **اجرای برنامه:**
```bash
gradio app.py
```
حالا می‌توانید برنامه را در مرورگر خود از طریق آدرس `http://127.0.0.1:7860` مشاهده کنید.
## ☁️ استقرار در Hugging Face Spaces
این پروژه برای استقرار در Spaces بهینه شده است:
1. یک Space جدید از نوع **Gradio SDK** در Hugging Face بسازید.
2. فایل‌های `app.py` و `requirements.txt` را در آن آپلود کنید.
3. به بخش **Settings > Secrets** بروید و یک Secret جدید با نام `OPENROUTER_API_KEY` و مقدار کلید API خود بسازید.
4. Space به طور خودکار برنامه را ساخته و اجرا خواهد کرد.
## 🤝 مشارکت
از هرگونه مشارکت، گزارش باگ یا پیشنهاد برای بهبود پروژه استقبال می‌شود. لطفاً یک Issue باز کنید یا یک Pull Request ارسال نمایید.
## 📄 مجوز
این پروژه تحت مجوز Apache منتشر شده است.
=======
---
title: DeepDream
emoji: 📊
colorFrom: red
colorTo: pink
sdk: gradio
sdk_version: 5.47.0
app_file: app.py
pinned: false
license: apache-2.0
short_description: Intelligent Dream Interpreter (Morphius)🔮
---
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
>>>>>>> 88299fea5a14245a0152f59c48b53da35ba7e0a5