Skip to content

Commit 9c52338

Browse files
authored
Update README.md
Clarification and inclusion of FS application notes
1 parent c965487 commit 9c52338

File tree

1 file changed

+20
-28
lines changed

1 file changed

+20
-28
lines changed

README.md

Lines changed: 20 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,24 @@
1-
# QuantCoder v0.3
1+
# The QuantCoder Project
22

3-
QuantCoder is a tool designed to streamline the process of searching for research articles, downloading PDFs, summarizing content, and generating QuantConnect Python algorithms based on the extracted data.
3+
QuantCoder is a tool designed to streamline the process of searching for research articles, downloading PDFs, summarizing content, and generating QuantConnect Python algorithms based on the extracted data. This project was initiated in November 2023 with the goal of leveraging large language models (LLMs) within the LangChain framework to autonomously develop trading algorithms.
44

5-
For an explanation of the code, refer to article : https://medium.com/ai-advances/from-finance-papers-to-trading-algorithms-an-automated-approach-ccd2180ee306?sk=c1e67131cd822bccc1acab1b53ae5331
5+
## Background
66

7-
This code is now integrated as coding engine in the project QuantCoder_FS, expected to be released Q2 2025. Refer to aricle : https://medium.com/ai-advances/towards-automating-quantitative-finance-research-c868a2a6477e
8-
Screenshots of the development are visible in a dedicated folder QuantCoder_FS_Demo.
7+
The initial version of QuantCoder was a Python prototype that utilized a cognitive architecture described in the article ["Dual Agent Chatbots and Expert Systems Design"](https://towardsdev.com/dual-agent-chatbots-and-expert-systems-design-25e2cba434e9) published by Towards Dev. This version successfully coded a blended momentum and mean-reversion strategy, as explained in the article ["Outperforming the Market (1000% in 10 years)"](https://medium.com/coinmonks/how-to-outperform-the-market-fe151b944c77?sk=7066045abe12d5cf88c7edc80ec2679c), which garnered significant attention with over 10,000 impressions on LinkedIn.
98

10-
## Features
9+
## Current Evolution : QuantCoder v0.3
10+
11+
The current version, QuantCoder v0.3, is detailed in the article ["From Finance Papers to Trading Algorithms: An Automated Approach"](https://ai.gopubby.com/from-finance-papers-to-trading-algorithms-an-automated-approach-ccd2180ee306) and is available in this repository. It received notable attention in the publication AI Advances.
12+
13+
### Features
1114

1215
- **Search Articles**: Query the CrossRef API to find relevant journal articles.
1316
- **List Articles**: View previously searched articles.
1417
- **Download PDFs**: Download article PDFs using direct links or Unpaywall.
1518
- **Summarize Articles**: Generate concise summaries of downloaded articles.
1619
- **Generate QuantConnect Code**: Create QuantConnect Python algorithms based on article summaries.
17-
- **Interactive Mode**: Perform all steps interactively with guided prompts.
18-
19-
## Installation
20-
21-
Detailed installation instructions will be provided once the CLI is fully set up.
2220

23-
## Usage
21+
### Usage
2422

2523
To launch the interactive mode of **QuantCLI**, follow these steps:
2624

@@ -31,28 +29,22 @@ To launch the interactive mode of **QuantCLI**, follow these steps:
3129
```bash
3230
quantcli interactive
3331

34-
## Project History
32+
### Strategies
3533

36-
The project was initiated in November 2023 with the goal of leveraging large language models (LLMs) within the LangChain framework to autonomously develop a trading algorithm.
37-
The cognitive architecture underpinning this system is comprehensively detailed in the article:
38-
https://medium.com/towardsdev/dual-agent-chatbots-and-expert-systems-design-25e2cba434e9
34+
A folder in this repository contains trading strategies generated using the QuantCoder tool. These strategies may have been refined manually or enhanced using other LLM-based methods. Please note that the author assumes no responsibility for the performance, accuracy, or outcomes resulting from the use of these strategies. Traders are strongly advised to exercise due diligence, conduct thorough research, and independently validate any strategy before applying it in live trading or investment activities.
3935

40-
The trading strategy generated by the system is elaborated in this article:
41-
https://medium.com/coinmonks/how-to-outperform-the-market-fe151b944c77
42-
Following a LinkedIn post announcing this innovative approach, which garnered approximately 10,000 impressions, I published several articles on AI-assisted pair-coding.
43-
This positive reception inspired me to integrate the research, summarization of quantitative finance articles, and algorithm coding into a unified workflow. More insights
44-
can be found in the article:
45-
https://medium.com/ai-advances/from-finance-papers-to-trading-algorithms-an-automated-approach-ccd2180ee306
46-
which received significant attention in publication AI advances.
36+
## Full-stack application : QuantCoder_FS
4737

48-
Subsequently, I released the initial proof of concept workflow (v0.1) on GitHub. The codebase was then refactored to adhere more closely to object-oriented programming (OOP)
49-
standards in version 0.2, and a user interface was introduced in version 0.3.
38+
QuantCoder v0.3 has been integrated as a coding engine in the full-stack version of QuantCoder, currently under development in a private repository. This full-stack version includes:
5039

51-
As of December 2024, I am developing the full-stack version of this tool (v0.3). The next phase involves enhancing code generation accuracy through an agent-based workflow
52-
using the CrewAI framework. I anticipate releasing the beta version to the quantitative finance community in Q3 2025.
40+
- **Chat with Fundamentals**: Instant financial analysis by accessing EODHD data.
41+
- **Search Articles**: Locate relevant academic articles.
42+
- **Summarize Articles**: Extract key insights from articles.
43+
- **Code Articles**: Generate trading algorithms based on article summaries.
5344

45+
These workflows are designed to evolve continuously, improving with advancements in LLMs and cognitive frameworks. For transparency and collaboration, these workflows will be demonstrated as Jupyter notebooks in this repository and in relevant Medium articles.
5446

5547
## License
5648

57-
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
49+
The material contained this repo is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
5850

0 commit comments

Comments
 (0)