Pull request bh

.gitignore

@@ -0,0 +1,6 @@
+.idea
+data/embeddings/*
+data/processed/*
+data/raw/*
+__pycache__/
+venv

README.md

@@ -1,3 +1,80 @@
-# CourseProject
+```plaintext
+AutoDash/
+|-- .gitignore
+|-- README.md
+|-- requirements.txt
+|-- docker-compose.yml (optional)
 
-Please fork this repository and paste the github link of your fork on Microsoft CMT. Detailed instructions are on Coursera under Week 1: Course Project Overview/Week 9 Activities.
+|-- data/
+|   |-- raw/
+|   |-- processed/
+|   |-- embeddings/
+
+|-- notebooks/
+|   |-- EDA.ipynb
+|   |-- model_prototyping.ipynb
+|   |-- etc.ipynb
+
+|-- src/
+|   |-- __init__.py
+|   |-- main.py
+|   |-- utils/
+|       |-- __init__.py
+|       |-- database_utils.py
+|       |-- network_graph.py
+|       |-- query_expansion.py
+|   |-- search/
+|       |-- __init__.py
+|       |-- scrape_documents.py
+|   |-- preprocessing/
+|       |-- __init__.py
+|       |-- text_preprocessing.py
+|   |-- models/
+|       |-- __init__.py
+|       |-- topic_model.py
+|       |-- sentiment_model.py
+|       |-- summarization_model.py
+|       |-- embeddings.py
+|   |-- dashboard/
+|       |-- __init__.py
+|       |-- dashboard.py
+
+```
+
+### Explanation
+
+1. **.gitignore**: To exclude files that shouldn't be tracked, such as temporary files or secrets.
+
+2. **README.md**: For project description, setup guide, etc.
+
+3. **requirements.txt**: Required Python packages.
+
+5. **docker-compose.yml**: For containerization and package setup if you intend to use these technologies.
+
+6. **data/**: To store raw and processed data.
+   - **raw/**: Original, immutable data dump.
+   - **processed/**: Cleaned data that feeds into models.
+   - **embeddings/**: Any pre-trained or generated embeddings.
+
+7. **notebooks/**: Jupyter notebooks for EDA and model prototyping.
+
+8. **src/**: All the source code.
+   - **main.py**: Main script to run tasks.
+   - **utils/**: Utility functions like database utilities.
+   - **search/**: Functions related to scraping and search engine API calls.
+   - **preprocessing/**: Text preprocessing functions.
+   - **models/**: Machine learning and NLP models.
+   - **dashboard/**: Code to create and manage the dashboard.
+
+## dependencies
+1. Python 3.11
+2. Elasticsearch 7.15.0
+
+
+
+## Setup
+1. Run docker-compose up -d to start the elasticsearch container
+   - elasticsearch is available at http://localhost:9200
+   - kibana is available at http://localhost:5601
+   - username: elastic, password: abcdefg
+   - we usually don't interact with elasticsearch directly, but it's useful for visual inspection of the data

docker-compose.yml

@@ -0,0 +1,46 @@
+version: '3.7'
+services:
+  elasticsearch:
+    image: docker.elastic.co/elasticsearch/elasticsearch:7.15.0
+    container_name: elasticsearch-single-node
+    environment:
+      - node.name=elasticsearch1
+      - cluster.name=es-docker-cluster
+      - bootstrap.memory_lock=true
+      - "ES_JAVA_OPTS=-Xms512m -Xmx512m"
+      - "discovery.type=single-node"  # Essential for single-node
+      - ELASTIC_PASSWORD=abcdefg  # Setting password explicitly
+      - xpack.security.enabled=true
+    ulimits:
+      memlock:
+        soft: -1
+        hard: -1
+    volumes:
+      - es-data:/usr/share/elasticsearch/data
+    ports:
+      - "9200:9200"  # Binding to localhost
+      - "9300:9300"
+    networks:
+      - es-net
+
+  kibana:
+    image: docker.elastic.co/kibana/kibana:7.15.0
+    container_name: kibana
+    environment:
+      ELASTICSEARCH_URL: "http://elasticsearch:9200"
+      ELASTICSEARCH_USERNAME: "elastic"
+      ELASTICSEARCH_PASSWORD: "abcdefg"  # Setting password explicitly
+    ports:
+      - "5601:5601"  # Binding to localhost
+    networks:
+      - es-net
+    depends_on:
+      - elasticsearch
+
+networks:
+  es-net:
+    driver: bridge
+
+volumes:
+  es-data:
+    driver: local

notebooks/EDA.ipynb

@@ -0,0 +1,34 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "collapsed": true
+   },
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 2
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython2",
+   "version": "2.7.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 0
+}