Download README from AI-Driven-Data-Driven/Arabic-Rag-Chatbot: direct link, hf CLI and curl.
- Browser
- Download file 1.83 kB
-
https://huggingface.co/spaces/AI-Driven-Data-Driven/Arabic-Rag-Chatbot/resolve/main/README
- Command line
-
hf download hf://spaces/AI-Driven-Data-Driven/Arabic-Rag-Chatbot/README
-
curl -L -o README https://huggingface.co/spaces/AI-Driven-Data-Driven/Arabic-Rag-Chatbot/resolve/main/README
1.83 kB
| # ArabicRAG: Arabic Retrieval-Augmented Generation | |
| ### Project Structure | |
| # arabic_legal_search/ | |
| # βββ config.py | |
| # βββ document_processor.py | |
| # βββ embedding_generator.py | |
| # βββ search_engine.py | |
| # βββ response_generator.py | |
| # βββ utils.py | |
| # βββ main.py | |
| # βββ requirements.txt | |
| ## Overview | |
| ArabicRAG is an open-source project designed to leverage the power of retrieval-augmented generation for processing and understanding Arabic legal documents. The system integrates advanced NLP techniques to retrieve relevant documents and generate context-aware responses. | |
| ## Features | |
| - **Document Processing**: Load and preprocess Arabic text documents efficiently. | |
| - **Embedding Generation**: Utilize multilingual models to generate embeddings for Arabic text. | |
| - **Efficient Search**: Leverage FAISS for fast and efficient similarity search in large document corpora. | |
| - **Response Generation**: Use state-of-the-art transformer models to generate responses based on retrieved context. | |
| ## Installation | |
| To set up your environment and run ArabicRAG, follow these steps: | |
| 1. Clone the repository: | |
| ```bash | |
| git clone https://github.com/maljefairi/arabicRAG | |
| ``` | |
| 2. Install the required packages: | |
| ```bash | |
| pip install -r requirements.txt | |
| ``` | |
| ## Usage | |
| After installation, you can run the main script to start processing documents: | |
| ```bash | |
| python main.py | |
| ``` | |
| ## Contributing | |
| Contributions are welcome! For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate. | |
| ## License | |
| This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. | |
| ## Contact | |
| - **Dr. Mohammed Al-Jefairi** - maljefairi@sidramail.com | |
| - **GitHub**: [maljefairi](https://github.com/maljefairi/arabicRAG) | |