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

Update Overview Section and Fix Image Visibility in Performance Metrics #196

Closed
1 task done
Karthik3904 opened this issue Oct 27, 2024 · 3 comments · Fixed by #198
Closed
1 task done

Update Overview Section and Fix Image Visibility in Performance Metrics #196

Karthik3904 opened this issue Oct 27, 2024 · 3 comments · Fixed by #198
Assignees
Labels
bug Something isn't working gssoc-ext GSSoC'24 Extended Version hacktoberfest Hacktober Collaboration hacktoberfest-accepted Hacktoberfest 2024 level1 10 Points 🥇(GSSoC)

Comments

@Karthik3904
Copy link
Contributor

Has this bug been raised before?

  • I have checked "open" AND "closed" issues and this is not a duplicate

Description

Description

This issue includes two parts:

  1. Update the Overview Section: The current "Overview" section lacks detailed information. Updating it would help provide better context about the project’s purpose, data source, and objectives, which is essential for new users to understand the project.

    Suggested update for the overview:

    ## 🌞 Overview
    This project aims to predict the stock prices of **The State Bank of India (SBI)** using various machine learning regression algorithms. By leveraging historical stock data sourced from Yahoo Finance, this project provides insights into the performance of different regression models in stock price prediction for SBI.
    
    The primary objective is to compare model accuracy and performance metrics, such as RMSE, MAE, and MAPE, across multiple algorithms, ultimately identifying the most suitable regression approach for stock price forecasting.
  2. Fix Image Visibility in Performance Metrics: In the "Performance Metrics" section, the images intended to show the Root Mean Square Error (RMSE), Mean Absolute Error (MAE), and Mean Absolute Percentage Error (MAPE) for different regression algorithms are not loading. They appear as broken image icons. Correcting the image paths or links would improve the document's readability and presentation.

Steps to Reproduce

Steps to Reproduce

  1. Go to the Performance Metrics section of the document.
  2. Check the images intended to display RMSE, MAE, and MAPE values for 10 regression algorithms.
  3. Observe that the images are not visible and appear as broken icons.
  4. Review the Overview section for clarity and detail.

Screenshots

Screenshots

Please see the attached screenshots for reference:

  1. Performance Metrics with broken image icons:
    Screenshot 2024-10-27 133707

  2. Current Overview Section:
    Screenshot 2024-10-27 133857

Do you want to work on this issue?

Yes

If "yes" to the above, please explain how you would technically implement this.

To address this issue, I would:

  • Update the "Overview" section by editing the README or relevant markdown file to include the suggested content.
    Screenshot 2024-10-27 134912

  • Check the file paths or links for images in the "Performance Metrics" section to ensure correct display, possibly by confirming the images are correctly referenced and available in the repository.
    Screenshot 2024-10-27 134927
    Screenshot 2024-10-27 134944
    Screenshot 2024-10-27 134952


@Karthik3904 Karthik3904 added the bug Something isn't working label Oct 27, 2024
Copy link
Contributor

👋 Thanks for opening this issue! We appreciate your contribution. Please make sure you’ve provided all the necessary details and screenshots, and don't forget to follow our Guidelines and Code of Conduct. Happy coding! 🚀

Copy link
Contributor

✅ This issue has been successfully closed. Thank you for your contribution and helping us improve the project! If you have any more ideas or run into other issues, feel free to open a new one. Happy coding! 🚀

1 similar comment
Copy link
Contributor

✅ This issue has been successfully closed. Thank you for your contribution and helping us improve the project! If you have any more ideas or run into other issues, feel free to open a new one. Happy coding! 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working gssoc-ext GSSoC'24 Extended Version hacktoberfest Hacktober Collaboration hacktoberfest-accepted Hacktoberfest 2024 level1 10 Points 🥇(GSSoC)
Projects
None yet
2 participants