Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
PedroDnT authored Oct 24, 2024
1 parent d00149d commit ac3ea3a
Showing 1 changed file with 8 additions and 21 deletions.
29 changes: 8 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,13 @@
# Project Title
**Objective:**

A brief description of what this project does and who it's for
LLM_FinancialAnalysis is a project aimed at replicating the methodology used in the paper “Financial Analysis with LLM." This repository focuses on applying the methodology specifically to Brazilian public companies, aiming to replicate the study's methodology and learn how to interact with the OpenAI API.

## Installation
**Description:**

Use the package manager [poetry](https://python-poetry.org/) to install the dependencies.
In this project, I built a pipeline using OpenAI API to analyze financial statements stored in an SQL database. With this data, the model was prompted to analyze and predict key financial metrics. The objective was to test the ability of financial LLMs to predict future financial performance, particularly focusing on earnings.

```bash
poetry install
```
**Here's a step-by-step breakdown of the process:**

## Usage

```bash
poetry run python your_script.py
```

## Contributing
Pull requests are welcome. For major changes, please open an issue first
to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License
[MIT](https://choosealicense.com/licenses/mit/)
1. **Data Retrieval:** Using SQL, I retrieve financial data such as income statements and balance sheets for a list of companies based on their codes.
2. **Prompt Creation:** I designed a custom prompt template for the LLM, ensuring analysis of trends over at least five years of historical data.
3. **Prediction Generation:** The financial data and prompts are passed to OpenAI's GPT-4 model, which generates earnings predictions for different years, including trend analysis, key financial ratios, and reasoning behind the predictions.

0 comments on commit ac3ea3a

Please sign in to comment.