Skip to content

Commit 19604c0

Browse files
add
1 parent 6729e5e commit 19604c0

File tree

7 files changed

+420
-376
lines changed

7 files changed

+420
-376
lines changed

CODE_OF_CONDUCT.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to a positive environment for our community include:
10+
11+
- Using welcoming and inclusive language
12+
- Being respectful of differing viewpoints and experiences
13+
- Gracefully accepting constructive criticism
14+
- Focusing on what is best for the community
15+
- Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
- Trolling, insulting/derogatory comments, and personal or political attacks
21+
- Public or private harassment
22+
- Publishing others' private information without explicit permission
23+
- Other conduct that could reasonably be considered inappropriate in a professional setting
24+
25+
## Enforcement
26+
27+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
28+
29+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
30+
31+
## Attribution
32+
33+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
34+
35+
For answers to common questions about this code of conduct, see [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq)

CONTRIBUTING.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Contributing to TrendMaster
2+
3+
Thank you for your interest in contributing to TrendMaster! Your contributions are welcome and will help improve the library for everyone.
4+
5+
## How to Contribute
6+
7+
1. **Fork the Repository**: Click on the Fork button at the top of the repository page.
8+
2. **Clone the Forked Repository**: `git clone https://github.com/yourusername/TrendMaster.git`
9+
3. **Create a New Branch**: `git checkout -b feature/your-feature`
10+
4. **Make Your Changes**: Ensure your code is clean, well-documented, and follows the project's coding standards.
11+
5. **Commit Your Changes**: `git commit -m "Add your feature or fix"`
12+
6. **Push to Your Fork**: `git push origin feature/your-feature`
13+
7. **Create a Pull Request**: Go to the original repository and click on "New Pull Request."
14+
15+
## Code of Conduct
16+
17+
By participating in this project, you agree to follow the [Code of Conduct](CODE_OF_CONDUCT.md). Please report any violations to [[email protected]](mailto:[email protected]).
18+
19+
## License
20+
21+
By contributing to this project, you agree that your contributions will be licensed under the MIT License.

MANIFEST.in

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
include README.md
2+
include LICENSE

README.md

+30-12
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,35 @@
33
[![Python Version](https://img.shields.io/badge/python-3.7%2B-blue)](https://www.python.org/downloads/)
44
[![License](https://img.shields.io/badge/license-MIT-green)](https://opensource.org/licenses/MIT)
55
[![GitHub Stars](https://img.shields.io/github/stars/hemangjoshi37a/TrendMaster?style=social)](https://github.com/hemangjoshi37a/TrendMaster/stargazers)
6-
7-
TrendMaster leverages cutting-edge Transformer deep learning architecture to deliver highly accurate stock price predictions, empowering you to make informed investment decisions.
8-
9-
![TrendMaster Demo](https://user-images.githubusercontent.com/12392345/125791380-341cecb7-a605-4147-9310-e5055f30b220.gif)
6+
[![GitHub Forks](https://img.shields.io/github/forks/hemangjoshi37a/TrendMaster?style=social)](https://github.com/hemangjoshi37a/TrendMaster/fork)
7+
[![GitHub Issues](https://img.shields.io/github/issues/hemangjoshi37a/TrendMaster)](https://github.com/hemangjoshi37a/TrendMaster/issues)
8+
9+
TrendMaster is an advanced stock price prediction library that leverages Transformer deep learning architecture to deliver highly accurate predictions, empowering investors with data-driven insights.
10+
11+
## Table of Contents
12+
13+
- [Features](#features)
14+
- [Why TrendMaster?](#why-trendmaster)
15+
- [Installation](#installation)
16+
- [Quick Start](#quick-start)
17+
- [Sample Results](#sample-results)
18+
- [User Interface](#user-interface)
19+
- [Documentation](#documentation)
20+
- [Contributing](#contributing)
21+
- [License](#license)
22+
- [Show Your Support](#show-your-support)
23+
- [Contact](#contact)
24+
- [More from HJ Labs](#more-from-hj-labs)
25+
- [Try Our Algo Trading Platform hjAlgos](#try-our-algo-trading-platform-hjalgos)
1026

1127
## 🚀 Features
1228

13-
- Advanced Transformer-based prediction model
14-
- High accuracy with mean average error of just a few percentage points
15-
- Real-time data visualization
16-
- User-friendly interface
17-
- Customizable model parameters
18-
- Support for multiple stock symbols
29+
- **Advanced Transformer-based prediction model**
30+
- **High accuracy with mean average error of just a few percentage points**
31+
- **Real-time data visualization**
32+
- **User-friendly interface**
33+
- **Customizable model parameters**
34+
- **Support for multiple stock symbols**
1935

2036
## 📊 Why TrendMaster?
2137

@@ -77,10 +93,11 @@ train_data, test_data = data_loader.prepare_data(
7793
output_window=10,
7894
train_test_split=0.8
7995
)
96+
8097
import torch
8198
# Initialize model, trainer, and train the model
8299
device = torch.device('cuda' if torch.cuda.is_available() else 'cpu')
83-
print(f'Training of {device} device.')
100+
print(f'Training on {device} device.')
84101
model = TransAm(num_layers=2, dropout=0.2).to(device)
85102

86103
trainer = Trainer(model, device, learning_rate=0.001)
@@ -150,7 +167,7 @@ Check out our other exciting projects:
150167

151168
## 📫 Try Our Algo Trading Platform hjAlgos
152169

153-
Ready to elevate your trading strategy?
170+
Ready to elevate your trading strategy?
154171

155172
<a href="https://hjalgos.hjlabs.in" style="
156173
display: inline-block;
@@ -170,3 +187,4 @@ Ready to elevate your trading strategy?
170187
---
171188

172189
Created with ❤️ by [Hemang Joshi](https://github.com/hemangjoshi37a)
190+

setup.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55

66
setup(
77
name="trendmaster",
8-
version="0.2.0",
8+
version="0.2.3",
99
author="Hemang Joshi",
1010
author_email="[email protected]",
1111
description="Stock Price Prediction using Transformer Deep Learning Architecture",
1212
long_description=long_description,
1313
long_description_content_type="text/markdown",
1414
url="https://github.com/hemangjoshi37a/TrendMaster",
15-
packages=find_packages(exclude=["tests", "examples"]),
15+
packages=find_packages(exclude=["Training","Inference"]),
1616
classifiers=[
1717
"Development Status :: 3 - Alpha",
1818
"Intended Audience :: Developers",
@@ -40,4 +40,4 @@
4040
"trendmaster=trendmaster.cli:main",
4141
],
4242
},
43-
)
43+
)

0 commit comments

Comments
 (0)