From bc815d39746d0d56aced75556cf0e83c930c6d9e Mon Sep 17 00:00:00 2001 From: Siddharth Date: Wed, 8 May 2024 05:15:42 +0530 Subject: [PATCH] Updating Readme --- readme.md | 32 +++++++++++++++++++++++++------- 1 file changed, 25 insertions(+), 7 deletions(-) diff --git a/readme.md b/readme.md index 749c906..d3a37a6 100644 --- a/readme.md +++ b/readme.md @@ -24,15 +24,21 @@ This project focuses on extracting, analyzing, and visualizing key financial ins 1. Each of these features files are sent to LLM (**Mixtral-7b-Instruct**) via OpenRouterAPI and saved in `src/output/output-responses` 2. Using a python script these annual files for each firm is combined in text format which is stored in `src/output/pre-analysis_combined`. 3. This combined text is again sent to LLM (**Mixtral-7b-Instruct**) via OpenRouterAPI to obtain two types of files : text_insights, csv_insights. - (These files are used to ) + (These files are used to display content on web server) located in `src\analysis` + +- **Data Visualization**: The csv file format obtained from LLM is in txt format due to API limitation , a simple python script `(src/analysis/csv/txt_to_csv.py)` + converts the files into csv files + + + **Web Interface**: A Streamlit application has been created and deployed. `src\app` contains all the elemnts to run streamlit app. + ### Note -- **Data Visualization**: Interactive charts and graphs to display financial metrics and trends. -- **Web Interface**: A Streamlit application that allows users to select different firms and view corresponding financial insights and visualizations. + **For hosting purposes, a separate repo has been created for streamlit but it contains the same files as located in `src/app`.** ---- +--- -### Important terms and their need : +## Important terms and their need : ### Financial Statements and Performance Metrics - **Revenue**: Represents the total income generated by a business. @@ -63,7 +69,7 @@ This project focuses on extracting, analyzing, and visualizing key financial ins - **Fair Value Measurements**: Refers to the estimated value of an asset or liability based on market conditions. - **Geographic Concentration Risk**: Risk associated with a company's heavy reliance on a particular geographic region. ---- +--- ## Directory Structure @@ -104,10 +110,22 @@ FinTech-Lab-Summer-2024/ ## **Streamlit Link** -[url-link](www.google.com) +[10-K-Analysis](https://fintech-10k-analysis.streamlit.app/) ## Tech-Stack +Python has been used throughout the project. +Streamlit has been used to host the project. + +--- + +### Disclamer + +Since the project realibility heavily depends on LLM inference model,there is always scope for hallucinations and wrong inferences, thus it is recommended to always verify data +from secondary sources. Note: The project is still under development and currently obtained **graphs and contents** are unreliable. + +- Upgrading to a better model might help with inference. + ## Contributing