Update README.md

README.md

@@ -1,6 +1,8 @@
 # prodigy-ecfr-textcat
 
-Brief description of your project.
+## About the Project
+
+Our goal is to organize these financial institution rules and regulations so financial institutions  can go through newly created rules and regulations to know which departments to send the information to and to allow easy retrieval of these regulations when necessary. Text mining and information retrieval will allow a large step of the process to be automated. Automating these steps will allow less time and effort to be contributed for financial institutions employees. This allows more time and work to be used to accomplish other projects.
 
 ## Table of Contents
 
@@ -10,29 +12,49 @@ Brief description of your project.
   - [Installation](#installation)
 - [Usage](#usage)
 - [File Structure](#file-structure)
-- [Contributing](#contributing)
 - [License](#license)
 - [Acknowledgements](#acknowledgements)
 
-## About the Project
-
-Our goal is to organize these financial institution rules and regulations so financial institutions  can go through newly created rules and regulations to know which departments to send the information to and to allow easy retrieval of these regulations when necessary. Text mining and information retrieval will allow a large step of the process to be automated. Automating these steps will allow less time and effort to be contributed for financial institutions employees. This allows more time and work to be used to accomplish other projects.
-
 ## Getting Started
 
 Instructions on setting up the project on a local machine.
 
 ### Prerequisites
 
-List any software dependencies or libraries required to run the project.
+Before running the project, ensure you have the following software dependencies installed:
+- [Python 3.x](https://www.python.org/downloads/)
+- [spaCy](https://spacy.io/usage)
+- [Prodigy](https://prodi.gy/docs/) (optional)
 
 ### Installation
 
-Step-by-step instructions on how to install and configure the project.
+Follow these step-by-step instructions to install and configure the project:
+
+1. **Clone this repository to your local machine.**
+   ```bash
+   git clone <https://github.com/ManjinderUNCC/prodigy-ecfr-textcat.git>
+2. Install the required dependencies by running:
+```bash
+pip install -r requirements.txt
+```
 
 ## Usage
 
-Explain how to use the project, including any command-line arguments, configurations, or examples.
+To use the project, follow these steps:
+
+1. **Prepare your data:**
+   - Place your dataset files in the `/data` directory.
+   - Optionally, annotate your data using Prodigy and save the annotations in the `/data` directory.
+
+2. **Train the text classification model:**
+   - Run the training script located in the `/python_Code` directory.
+
+3. **Evaluate the model:**
+   - Use the evaluation script to assess the model's performance on labeled data.
+
+4. **Make predictions:**
+   - Apply the trained model to new, unlabeled data to classify it into relevant categories.
+
 
 ## File Structure
 
@@ -129,19 +151,17 @@ Describe the organization of files and directories within the project.
   - `thirdStep-label.py`
   - `train_eval_split.ipynb`
 - `TerminalCode.txt`
+- `requirements.txt`
+- `Terminal Commands vs Project.yml`
+- `Project.yml`
 - `README.md`
 - `prodigy.json`
 
-
-
-## Contributing
-
-Guidelines for contributing to the project, including how to report bugs or suggest improvements.
-
 ## License
 
-Specify the project's license (e.g., MIT License, Apache License 2.0).
+- Package A: MIT License
+- Package B: Apache License 2.0
 
 ## Acknowledgements
 
-Credits to any individuals, organizations, or resources that contributed to the project.
+Manjinder Sandhu, Dagim Bantikassegn, Alex Brooks, Tyler Dabbs