10KSENTIMENTNLP

► INSERT-TEXT-HERE

Table of Contents

• Overview
• Features
• Repository Structure
• Modules
• Getting Started
  • Installation
  • Usage
  • Tests
• Project Roadmap
• Contributing
• License
• Acknowledgments

---

Overview

This repo is the result of my final project at Lighthouse Labs. The idea is to use the NLP to derive a sentiment from the managament discussion and analysis section of a 10k to improve the accuracy of a stock price prediction algo.

---

Features

► INSERT-TEXT-HERE

---

Repository Structure

└── 10KSentimentNLP/
    ├── CompanyDL.ipynb
    ├── GetSedar.ipynb
    ├── PricesDL.ipynb
    ├── SentimentCount.ipynb
    ├── SentimentModel.ipynb
    ├── stock_price_lstm.ipynb
    └── temp.ipynb

---

Modules

.

File	Summary
SentimentCount.ipynb	► INSERT-TEXT-HERE
GetSedar.ipynb	► INSERT-TEXT-HERE
temp.ipynb	► INSERT-TEXT-HERE
stock_price_lstm.ipynb	► INSERT-TEXT-HERE
CompanyDL.ipynb	► INSERT-TEXT-HERE
PricesDL.ipynb	► INSERT-TEXT-HERE
SentimentModel.ipynb	► INSERT-TEXT-HERE

---

Getting Started

System Requirements:

• JupyterNotebook: version x.y.z

Installation

From source

1. Clone the 10KSentimentNLP repository:

$ git clone https://github.com/BlakSwan/10KSentimentNLP

2. Change to the project directory:

$ cd 10KSentimentNLP

3. Install the dependencies:

$ pip install -r requirements.txt

Usage

From source

Run 10KSentimentNLP using the command below:

$ jupyter nbconvert --execute notebook.ipynb

Tests

Run the test suite using the command below:

$ pytest notebook_test.py

---

Project Roadmap

• ► INSERT-TASK-1
• ► INSERT-TASK-2
• ► ...

---

Contributing

Contributions are welcome! Here are several ways you can contribute:

• Report Issues: Submit bugs found or log feature requests for the 10KSentimentNLP project.
• Submit Pull Requests: Review open PRs, and submit your own PRs.
• Join the Discussions: Share your insights, provide feedback, or ask questions.

Contributing Guidelines

1. Fork the Repository: Start by forking the project repository to your github account.
2. Clone Locally: Clone the forked repository to your local machine using a git client.

   git clone https://github.com/BlakSwan/10KSentimentNLP

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear message describing your updates.

   git commit -m 'Implemented new feature x.'

6. Push to github: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!

Contributor Graph

---

License

This project is protected under the SELECT-A-LICENSE License. For more details, refer to the LICENSE file.

---

Acknowledgments

• List any resources, contributors, inspiration, etc. here.

Return

---