gavindiaz/NexQuant
1
0
Fork 0
mirror of https://github.com/NicolasBohn/NexQuant.git synced 2026-08-02 09:57:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Refine docs (#200)

Browse Source 
* Update docs

* update one demo video

* update docs

* remove the video

* move configuration file

* fix demo title
This commit is contained in:
you-n-g
2024-08-09 19:55:35 +08:00
committed by GitHub
parent b47ad23b87
commit 22dbb86fd4
9 changed files with 123 additions and 103 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/development.rst
+1 -1
View File
@@ -73,4 +73,4 @@ File Naming Convention
* - `conf.py`
- The configuration for the module, app, and project.
<!-- TODO: renaming files -->
.. <!-- TODO: renaming files -->
docs/installation_and_configuration.rst
+22
View File
@@ -143,3 +143,25 @@ Configuration List
| max_past_message_include | Maximum number of past messages to include | 10 |
+------------------------------+--------------------------------------------------+-------------------------+
Loading Configuration
---------------------
For users' convenience, we provide a CLI interface called `rdagent`, which automatically runs `load_dotenv()` to load environment variables from the `.env` file.
However, this feature is not enabled by default for other scripts. We recommend users load the environment with the following steps:
- ⚙️ Environment Configuration
- Place the `.env` file in the same directory as the `.env.example` file.
- The `.env.example` file contains the environment variables required for users using the OpenAI API (Please note that `.env.example` is an example file. `.env` is the one that will be finally used.)
- Export each variable in the .env file:
.. code-block:: sh
export $(grep -v '^#' .env | xargs)
- If you want to change the default environment variables, you can refer to the above configuration and edith the `.env` file.
docs/project_framework_introduction.rst
+2 -16
View File
@@ -23,19 +23,5 @@ We have established a basic method framework that continuously proposes hypothes
The figure above shows the main classes and how they fit into the workflow for those interested in the detailed code.
Detailed Design
=========================
Configuration
-------------
You can manually source the `.env` file in your shell before running the Python script:
Most of the workflow are controlled by the environment variables.
```sh
# Export each variable in the .env file; Please note that it is different from `source .env` without export
export $(grep -v '^#' .env | xargs)
# Run the Python script
python your_script.py
```
.. Detailed Design
.. ===============
docs/scens/data_agent_fin.rst
+14 -10
View File
@@ -17,9 +17,17 @@ By leveraging these factors, quantitative traders can develop sophisticated stra
The ability to systematically analyze and apply these factors is what separates ordinary trading from truly strategic market outmaneuvering.
And this is where the **Finance Model Agent** comes into play.
🎥 Demo
~~~~~~~~~~
TODO: Here should put a video of the demo.
🎥 `Demo <https://rdagent.azurewebsites.net/factor_loop>`_
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. https://rdagent.azurewebsites.net:443/media/54d59c2bf85211de6a7cd2bd3c57d3b56c36cf9795a31111a9111ddb.mp4
.. raw:: html
<video width="600" controls>
<source src="https://rdagent.azurewebsites.net:443/media/54d59c2bf85211de6a7cd2bd3c57d3b56c36cf9795a31111a9111ddb.mp4" type="video/mp4">
Your browser does not support the video tag.
</video>
🌟 Introduction
@@ -75,6 +83,8 @@ Here's an enhanced outline of the steps:
⚡ Quick Start
~~~~~~~~~~~~~~~~~
Please refer to the installation part in :doc:`../installation_and_configuration` to prepare your system dependency.
You can try our demo by running the following command:
- 🐍 Create a Conda Environment
@@ -97,12 +107,6 @@ You can try our demo by running the following command:
pip install rdagent
- ⚙️ Environment Configuration
- Place the `.env` file in the same directory as the `.env.example` file.
- The `.env.example` file contains the environment variables required for users using the OpenAI API (Please note that `.env.example` is an example file. `.env` is the one that will be finally used.)
- If you want to change the default environment variables, you can refer to `Env Config`_ below
- 🚀 Run the Application
.. code-block:: sh
@@ -126,4 +130,4 @@ The following environment variables can be set in the `.env` file to customize t
:settings-show-field-summary: False
:members: coder_use_cache, data_folder, data_folder_debug, cache_location, enable_execution_cache, file_based_execution_timeout, select_method, select_threshold, max_loop, knowledge_base_path, new_knowledge_base_path
:exclude-members: Config, fail_task_trial_limit, v1_query_former_trace_limit, v1_query_similar_success_limit, v2_query_component_limit, v2_query_error_limit, v2_query_former_trace_limit, v2_error_summary, v2_knowledge_sampler
:no-index:
:no-index:
docs/scens/data_copilot_fin.rst
+13 -10
View File
@@ -20,9 +20,16 @@ Therefore, there is an urgent need for a systematic approach to design a framewo
And this is where the **Finance Data Copilot** steps in.
🎥 Demo
~~~~~~~~~~
TODO: Here should put a video of the demo.
🎥 `Demo <https://rdagent.azurewebsites.net/report_factor>`_
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. raw:: html
<video width="600" controls>
<source src="https://rdagent.azurewebsites.net:443/media/42a3280d592fb9e3d227608170860c426fc2bf5c63eea5a66ed94ca7.mp4" type="video/mp4">
Your browser does not support the video tag.
</video>
🌟 Introduction
@@ -76,6 +83,8 @@ Here's an enhanced outline of the steps:
⚡ Quick Start
~~~~~~~~~~~~~~~~~
Please refer to the installation part in :doc:`../installation_and_configuration` to prepare your system dependency.
You can try our demo by running the following command:
- 🐍 Create a Conda Environment
@@ -98,12 +107,6 @@ You can try our demo by running the following command:
pip install rdagent
- ⚙️ Environment Configuration
- Place the `.env` file in the same directory as the `.env.example` file.
- The `.env.example` file contains the environment variables required for users using the OpenAI API (Please note that `.env.example` is an example file. `.env` is the one that will be finally used.)
- If you want to change the default environment variables, you can refer to `Env Config`_ below
- 🚀 Run the Application
- Store the factors you want to extract from the financial reports in your desired folder. Then, save the paths of the reports in the `report_result_json_file_path`. The format should be as follows:
@@ -139,4 +142,4 @@ The following environment variables can be set in the `.env` file to customize t
:settings-show-field-summary: False
:members: coder_use_cache, data_folder, data_folder_debug, cache_location, enable_execution_cache, file_based_execution_timeout, select_method, select_threshold, max_loop, knowledge_base_path, new_knowledge_base_path
:exclude-members: Config, python_bin, fail_task_trial_limit, v1_query_former_trace_limit, v1_query_similar_success_limit, v2_query_component_limit, v2_query_error_limit, v2_query_former_trace_limit, v2_error_summary, v2_knowledge_sampler
:no-index:
:no-index:
docs/scens/model_agent_fin.rst
+17 -16
View File
@@ -16,9 +16,20 @@ The effectiveness of a quantitative strategy depends not only on the factors use
However, the process of developing and optimizing these models can be labor-intensive and complex, requiring continuous refinement and adaptation to ever-changing market conditions.
And this is where the **Finance Model Agent** steps in.
🎥 Demo
~~~~~~~~~~
TODO: Here should put a video of the demo.
🎥 `Demo <https://rdagent.azurewebsites.net/model_loop>`_
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. raw:: html
<video width="600" controls>
<source src="https://rdagent.azurewebsites.net:443/media/5275fcb75803ad2bb9541c3abd86dedfd578a28fa32b46fa28917b33.mp4" type="video/mp4">
Your browser does not support the video tag.
</video>
🌟 Introduction
@@ -74,6 +85,8 @@ Here's an enhanced outline of the steps:
⚡ Quick Start
~~~~~~~~~~~~~~~~~
Please refer to the installation part in :doc:`../installation_and_configuration` to prepare your system dependency.
You can try our demo by running the following command:
- 🐍 Create a Conda Environment
@@ -96,18 +109,6 @@ You can try our demo by running the following command:
pip install rdagent
- ⚙️ Environment Configuration
- Place the `.env` file in the same directory as the `.env.example` file.
- The `.env.example` file contains the environment variables required for users using the OpenAI API (Please note that `.env.example` is an example file. `.env` is the one that will be finally used.)
- Export each variable in the .env file:
.. code-block:: sh
export $(grep -v '^#' .env | xargs)
- If you want to change the default environment variables, you can refer to `Env Config`_ below
- 🚀 Run the Application
.. code-block:: sh
@@ -143,4 +144,4 @@ The following environment variables can be set in the `.env` file to customize t
- **batch_size**: The batch size, set to `2000`.
- **metric**: The evaluation metric, set to `loss`.
- **loss**: The loss function, set to `mse`.
- **n_jobs**: The number of parallel jobs, set to `20`.
- **n_jobs**: The number of parallel jobs, set to `20`.
docs/scens/model_agent_med.rst
+12 -15
View File
@@ -12,9 +12,15 @@ Medical Model Agent
In this scenario, we consider the problem of risk prediction from patients' ICU monitoring data. We use the a public EHR dataset - MIMIC-III and extract a binary classification task for evaluating the framework.
In this task, we aim at predicting the whether the patients will suffer from Acute Respiratory Failure (ARF) based their first 12 hours ICU monitoring data.
🎥 Demo
~~~~~~~~~~
TODO: Here should put a video of the demo.
🎥 `Demo <https://rdagent.azurewebsites.net/dmm>`_
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. raw:: html
<video width="600" controls>
<source src="https://rdagent.azurewebsites.net:443/media/0fbd26bb297369a4ca52409ff65a3f7cb941c6af6429894367a6afcd.mp4" type="video/mp4">
Your browser does not support the video tag.
</video>
🌟 Introduction
@@ -58,6 +64,8 @@ Here's an enhanced outline of the steps:
⚡ Quick Start
~~~~~~~~~~~~~~~~~
Please refer to the installation part in :doc:`../installation_and_configuration` to prepare your system dependency.
You can try our demo by running the following command:
- 🐍 Create a Conda Environment
@@ -85,17 +93,6 @@ You can try our demo by running the following command:
- Request access to FIDDLE preprocessed data: `FIDDLE Dataset <https://physionet.org/content/mimic-eicu-fiddle-feature/1.0.0/>`_.
- Place your username and password in `.rdagent.app.data_mining.conf`.
- ⚙️ Environment Configuration
- Place the `.env` file in the same directory as the `.env.example` file.
- The `.env.example` file contains the environment variables required for users using the OpenAI API (Please note that `.env.example` is an example file. `.env` is the one that will be finally used.)
- Export each variable in the .env file:
.. code-block:: sh
export $(grep -v '^#' .env | xargs)
- If you want to change the default environment variables, you can refer to `Env Config`_ below
- 🚀 Run the Application
.. code-block:: sh
@@ -113,4 +110,4 @@ The following environment variables can be set in the `.env` file to customize t
.. autopydantic_settings:: rdagent.app.data_mining.conf.PropSetting
:settings-show-field-summary: False
:exclude-members: Config
:exclude-members: Config
docs/scens/model_copilot_general.rst
+12 -8
View File
@@ -15,9 +15,15 @@ However, reproducing and implementing these models can be a daunting task, requi
Researchers often face challenges in extracting the essential details from these papers and converting them into functional code.
And this is where the **General Model Copilot** steps in.
🎥 Demo
~~~~~~~~~~
TODO: Here should put a video of the demo.
🎥 `Demo <https://rdagent.azurewebsites.net/report_model>`_
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. raw:: html
<video width="600" controls>
<source src="https://rdagent.azurewebsites.net:443/media/434d28b544e61441da19a4335e1ccab173f2b5a5bba487df765ce06c.mp4" type="video/mp4">
Your browser does not support the video tag.
</video>
🌟 Introduction
~~~~~~~~~~~~~~~~
@@ -49,6 +55,8 @@ This demo automates the extraction and iterative development of models from acad
⚡ Quick Start
~~~~~~~~~~~~~~~~~
Please refer to the installation part in :doc:`../installation_and_configuration` to prepare your system dependency.
You can try our demo by running the following command:
- 🐍 Create a Conda Environment
@@ -72,10 +80,6 @@ You can try our demo by running the following command:
pip install rdagent
- ⚙️ Environment Configuration
- Place the `.env` file in the same directory as the `.env.example` file.
- The `.env.example` file contains the environment variables required for users using the OpenAI API (Please note that `.env.example` is an example file. `.env` is the one that will be finally used.)
- 🚀 Run the Application
- Prepare relevant files (in pdf format) by uploading papers to the directory below and copy the path as report_file_path.
@@ -87,4 +91,4 @@ You can try our demo by running the following command:
.. code-block:: sh
rdagent general_model --report_file_path=<path_to_pdf_file>
rdagent general_model --report_file_path=<path_to_pdf_file>