Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[README Enhacement]: ASELSAN Stock Prices #604

Merged
merged 2 commits into from
Jun 2, 2024

Conversation

nkhanna94
Copy link
Contributor

@nkhanna94 nkhanna94 commented Jun 1, 2024

This commit enhances the README.md file for the ASELSAN Stock Price Prediction Project.

Changes Made:

  • Provided a comprehensive overview of the project, including its goal, dataset, project progress, libraries used, key visualizations, and conclusion.
  • Structured the README to improve readability and clarity.
  • Included direct links to the dataset and author's GitHub profile.
  • Ensured consistency in formatting and language throughout the document.

These enhancements aim to provide readers with a clear understanding of the project and its objectives, facilitating easier navigation and comprehension.

Pull Request for ML-Crate 💡

Issue Title: [README Enhacement]: ASELSAN Stock Prices

  • Info about the related issue (Aim of the project) : The aim of this project is to develop a machine learning model capable of predicting the stock prices of ASELSAN, a leading defense technology company in Turkey.
  • Name: Niharika Khanna
  • GitHub ID: nkhanna94
  • Identify yourself: Contributor @SSOC-S3

Closes: 597
Updated Issue Number: 604

Describe the add-ons or changes you've made 📃

Give a clear description of what have you added or modifications made
Changes Made:
This pull request updates the README.md file for the ASELSAN Stock Price Prediction Project with detailed information and results.

Changes Made:

  • Added a comprehensive goal section outlining the purpose of the project.
  • Included a link to the dataset sourced from Kaggle.
  • Provided a brief description of the project.
  • Documented the step-by-step procedure of the project, including data preprocessing (deleting unnecessary columns and changing data types), visualization, and model development.
  • Listed the machine learning models implemented and the rationale for choosing them.
  • Detailed the libraries needed for the project.
  • Included images of the exploratory data analysis (EDA) results.
  • Added performance metrics for each model based on train and test scores.
  • Updated the conclusion section to reflect the performance of the models and the final outcome.
  • Added a signature section with the author's contact information and social media handles.

These enhancements aim to provide a clear and detailed overview of the project, improving readability and understanding for future contributors and users.

Type of change ☑️

What sort of change have you made:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Code style update (formatting, local variables)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested? ⚙️

Describe how it has been tested
Describe how have you verified the changes made

Checklist: ☑️

  • My code follows the guidelines of this project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly wherever it was hard to understand.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have added things that prove my fix is effective or that my feature works.
  • Any dependent changes have been merged and published in downstream modules.

This commit enhances the README.md file for the ASELSAN Stock Price Prediction Project. 

Changes Made:
- Provided a comprehensive overview of the project, including its goal, dataset, project progress, libraries used, key visualizations, and conclusion.
- Structured the README to improve readability and clarity.
- Included direct links to the dataset and author's GitHub profile.
- Ensured consistency in formatting and language throughout the document.
  
These enhancements aim to provide readers with a clear understanding of the project and its objectives, facilitating easier navigation and comprehension.
Copy link

github-actions bot commented Jun 1, 2024

Our team will soon review your PR. Thanks @nkhanna94 :)

Copy link
Owner

@abhisheks008 abhisheks008 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/abhisheks008/ML-Crate/blob/main/.github/readme_template.md

Please follow the points mentioned in the given template and update your file accordingly.
@nkhanna94

@abhisheks008 abhisheks008 linked an issue Jun 2, 2024 that may be closed by this pull request
@abhisheks008 abhisheks008 added Requested Changes ⚙️ Some changes have been requested in this PR. SSOC labels Jun 2, 2024
This commit updates the README.md file for the ASELSAN Stock Price Prediction Project with detailed information and results.

Changes Made:
- Added a comprehensive goal section outlining the purpose of the project.
- Included a link to the dataset sourced from Kaggle.
- Provided a brief description of the project.
- Documented the step-by-step procedure of the project, including data preprocessing, visualization, and model development.
- Listed the machine learning models implemented and the rationale for choosing them.
- Detailed the libraries needed for the project.
- Included images of the exploratory data analysis (EDA) results.
- Added performance metrics for each model based on train and test scores.
- Updated the conclusion section to reflect the performance of the models and the final outcome.
- Added a signature section with the author's contact information and social media handles.

These enhancements aim to provide a clear and detailed overview of the project, improving readability and understanding for future contributors and users.
Copy link
Owner

@abhisheks008 abhisheks008 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved @nkhanna94

@abhisheks008 abhisheks008 added Approved ✅ This PR is approved by the PR or, Mentors. Beginner 20 points : SSOC 2024 and removed Requested Changes ⚙️ Some changes have been requested in this PR. labels Jun 2, 2024
@abhisheks008 abhisheks008 merged commit e882d07 into abhisheks008:main Jun 2, 2024
@abhisheks008 abhisheks008 added the Points Added 🎉 This issue's points has been added to the leaderboard. label Jun 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved ✅ This PR is approved by the PR or, Mentors. Beginner 20 points : SSOC 2024 Points Added 🎉 This issue's points has been added to the leaderboard. SSOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[README Enhacement]: ASELSAN Stock Prices
2 participants