Update README.md
Browse files
README.md
CHANGED
@@ -118,19 +118,21 @@ The system is modular, consisting of several Python components:
|
|
118 |
- **Visualization: Customize graph appearance in src/visualization/plotting.py.**
|
119 |
- **Data Storage: Modify src/data_management/storage.py to use different formats or databases.**
|
120 |
|
121 |
-
##
|
|
|
|
|
122 |
C:.
|
123 |
-
│ requirements.txt # Project dependencies
|
124 |
-
│ reset_status.py # Utility script (optional)
|
125 |
-
│ run_analysis.py # Script to run the analysis pipeline
|
126 |
-
│ run_extractor.py # Script to run the extraction pipeline
|
127 |
-
│ run_loader.py # Script to run the data loading pipeline
|
128 |
-
│ README.md # Project description (This file!)
|
129 |
-
│ .gitignore #
|
130 |
│
|
131 |
-
├───data # Data directory
|
132 |
-
│ ├───processed_data #
|
133 |
-
│ │ analysis_*.parquet
|
134 |
│ │ concepts.parquet
|
135 |
│ │ concept_embeddings.pkl
|
136 |
│ │ concept_similarities.parquet
|
@@ -138,43 +140,43 @@ C:.
|
|
138 |
│ │ mentions.parquet
|
139 |
│ │ relationships.parquet
|
140 |
│ │
|
141 |
-
│ └───raw # Raw input data (e.g., PDFs)
|
142 |
-
│ example.pdf #
|
143 |
│
|
144 |
-
├───notebooks # Jupyter notebooks
|
145 |
│ exploration.ipynb
|
146 |
│
|
147 |
-
├───output # Output files
|
148 |
-
│ │ *.png #
|
149 |
│ │
|
150 |
-
│ ├───graphs # Interactive graph visualizations
|
151 |
│ │ concept_network_visualization.html
|
152 |
│ │
|
153 |
-
│ └───networks # Saved network data
|
154 |
│ concept_network.pkl
|
155 |
│
|
156 |
-
└───src # Source code directory
|
157 |
│ __init__.py
|
158 |
│
|
159 |
-
├───analysis # Analysis modules
|
160 |
│ │ __init__.py
|
161 |
-
│ │ network_analysis.py #
|
162 |
-
│ │ network_builder.py #
|
163 |
-
│ │ similarity.py #
|
164 |
-
│ │ temporal.py #
|
165 |
│
|
166 |
-
├───core # Core
|
167 |
│ │ __init__.py
|
168 |
│
|
169 |
-
├───data_management # Data
|
170 |
│ │ __init__.py
|
171 |
-
│ │ loaders.py #
|
172 |
-
│ │ storage.py #
|
173 |
│
|
174 |
-
├───extraction # Concept
|
175 |
│ │ __init__.py
|
176 |
-
│ │ extractor.py #
|
177 |
│
|
178 |
-
└───visualization # Visualization
|
179 |
│ __init__.py
|
180 |
-
│ plotting.py #
|
|
|
118 |
- **Visualization: Customize graph appearance in src/visualization/plotting.py.**
|
119 |
- **Data Storage: Modify src/data_management/storage.py to use different formats or databases.**
|
120 |
|
121 |
+
## 📁 Project Structure
|
122 |
+
|
123 |
+
```bash
|
124 |
C:.
|
125 |
+
│ requirements.txt # Project dependencies / Proje bağımlılıkları
|
126 |
+
│ reset_status.py # Utility script (optional) / Yardımcı script (isteğe bağlı)
|
127 |
+
│ run_analysis.py # Script to run the analysis pipeline / Analiz hattını çalıştırır
|
128 |
+
│ run_extractor.py # Script to run the extraction pipeline / Kavram çıkarımı hattını çalıştırır
|
129 |
+
│ run_loader.py # Script to run the data loading pipeline / Veri yükleme hattını çalıştırır
|
130 |
+
│ README.md # Project description (This file!) / Proje açıklaması (Bu dosya!)
|
131 |
+
│ .gitignore # Git için hariç tutulan dosyalar
|
132 |
│
|
133 |
+
├───data # Data directory / Veri dizini
|
134 |
+
│ ├───processed_data # Output of processed data / İşlenmiş veriler
|
135 |
+
│ │ analysis_*.parquet
|
136 |
│ │ concepts.parquet
|
137 |
│ │ concept_embeddings.pkl
|
138 |
│ │ concept_similarities.parquet
|
|
|
140 |
│ │ mentions.parquet
|
141 |
│ │ relationships.parquet
|
142 |
│ │
|
143 |
+
│ └───raw # Raw input data (e.g., PDFs) / Ham giriş verisi
|
144 |
+
│ example.pdf # Giriş PDF dosyaları buraya eklenir
|
145 |
│
|
146 |
+
├───notebooks # Jupyter notebooks (optional) / Jupyter defterleri (isteğe bağlı)
|
147 |
│ exploration.ipynb
|
148 |
│
|
149 |
+
├───output # Output files / Çıktı dosyaları
|
150 |
+
│ │ *.png # Görsel çıktılar (varsa)
|
151 |
│ │
|
152 |
+
│ ├───graphs # Interactive graph visualizations / Etkileşimli grafikler
|
153 |
│ │ concept_network_visualization.html
|
154 |
│ │
|
155 |
+
│ └───networks # Saved network data / Kayıtlı ağ verileri
|
156 |
│ concept_network.pkl
|
157 |
│
|
158 |
+
└───src # Source code directory / Kaynak kod dizini
|
159 |
│ __init__.py
|
160 |
│
|
161 |
+
├───analysis # Analysis modules / Analiz modülleri
|
162 |
│ │ __init__.py
|
163 |
+
│ │ network_analysis.py # Ağ metriklerini hesaplar
|
164 |
+
│ │ network_builder.py # NetworkX graph oluşturur
|
165 |
+
│ │ similarity.py # Anlamsal benzerlik hesaplar
|
166 |
+
│ │ temporal.py # Zaman serisi analizi yapar
|
167 |
│
|
168 |
+
├───core # Core utilities / Temel yardımcılar
|
169 |
│ │ __init__.py
|
170 |
│
|
171 |
+
├───data_management # Data management / Veri yönetimi
|
172 |
│ │ __init__.py
|
173 |
+
│ │ loaders.py # PDF gibi ham verileri yükler
|
174 |
+
│ │ storage.py # Parquet/Pickle formatlarında veri kaydeder/yükler
|
175 |
│
|
176 |
+
├───extraction # Concept extraction / Kavram çıkarımı
|
177 |
│ │ __init__.py
|
178 |
+
│ │ extractor.py # spaCy kullanarak kavram çıkarımı yapar
|
179 |
│
|
180 |
+
└───visualization # Visualization tools / Görselleştirme araçları
|
181 |
│ __init__.py
|
182 |
+
│ plotting.py # Pyvis, Matplotlib vb. ile grafik oluşturur
|