Spaces:
Sleeping
Sleeping
Update docs/README.md
Browse files- docs/README.md +21 -19
docs/README.md
CHANGED
|
@@ -115,24 +115,26 @@ This application is designed for deployment on [Hugging Face Spaces](https://hug
|
|
| 115 |
|
| 116 |
```
|
| 117 |
anveshak/
|
| 118 |
-
βββ .gitignore
|
| 119 |
-
βββ .gitattributes
|
| 120 |
-
βββ app.py
|
| 121 |
-
βββ requirements.txt
|
| 122 |
-
βββ rag_engine.py
|
| 123 |
-
βββ utils.py
|
| 124 |
-
βββ pages/
|
| 125 |
-
β βββ 1_Sources.py
|
| 126 |
-
β βββ 2_Publishers.py
|
| 127 |
-
β βββ 3_Contact_us.py
|
| 128 |
-
βββ docs/
|
| 129 |
-
β
|
| 130 |
-
β
|
| 131 |
-
β βββ
|
| 132 |
-
β βββ
|
| 133 |
-
β
|
| 134 |
-
|
| 135 |
-
|
|
|
|
|
|
|
| 136 |
```
|
| 137 |
|
| 138 |
## π Data Privacy & Ethics
|
|
@@ -203,4 +205,4 @@ This project is licensed under the Apache License 2.0 - see the [LICENSE](../LIC
|
|
| 203 |
|
| 204 |
## π Contact
|
| 205 |
|
| 206 |
-
For questions, feedback, or suggestions, please contact us at [email protected].
|
|
|
|
| 115 |
|
| 116 |
```
|
| 117 |
anveshak/
|
| 118 |
+
βββ .gitignore # Specifies intentionally untracked files to ignore
|
| 119 |
+
βββ .gitattributes # Defines attributes for pathnames in the repository
|
| 120 |
+
βββ app.py # Main Streamlit application
|
| 121 |
+
βββ requirements.txt # Python dependencies
|
| 122 |
+
βββ rag_engine.py # Core RAG functionality
|
| 123 |
+
βββ utils.py # Utility functions for authentication
|
| 124 |
+
βββ pages/ # Streamlit pages
|
| 125 |
+
β βββ 1_Sources.py # Sources information page
|
| 126 |
+
β βββ 2_Publishers.py # Publisher acknowledgments page
|
| 127 |
+
β βββ 3_Contact_us.py # Contact information page
|
| 128 |
+
βββ docs/ # Documentation
|
| 129 |
+
β βββ assets/ # Images and other media
|
| 130 |
+
β βββ app_screenshot.png # Application screenshot
|
| 131 |
+
β βββ architecture-doc.md # Architecture details
|
| 132 |
+
β βββ data-handling-doc.md # Data handling explanation
|
| 133 |
+
β βββ configuration-doc.md # Configuration guide
|
| 134 |
+
β βββ changelog-doc.md # Project change log
|
| 135 |
+
β βββ README.md # Project overview and instructions
|
| 136 |
+
βββ scripts/ # Data processing scripts
|
| 137 |
+
βββ preprocessing.ipynb # Text preprocessing notebook
|
| 138 |
```
|
| 139 |
|
| 140 |
## π Data Privacy & Ethics
|
|
|
|
| 205 |
|
| 206 |
## π Contact
|
| 207 |
|
| 208 |
+
For questions, feedback, or suggestions, please contact us at [email protected].
|