gavindiaz/NexQuant
1
0
Fork 0
mirror of https://github.com/NicolasBohn/NexQuant.git synced 2026-08-03 18:27:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: refine the README (#244)

Browse Source 
* init a scenario for kaggle feature engineering

* update the readme

* Delete rdagent/app/kaggle_feature/conf.py

* update some pictures

* Delete rdagent/app/kaggle_feature/model.py

* change a photo

* add pics to docs

* update the readme

* update the README

* for a try

* for another try

* change the style of the pictures in readme

* fix a small bug

* update the readme and the docs

* update the docs

* fix a typo

* change a website url

* change some styles

* fix a typo

* change the size of the logo

* change two urls

* Update README.md

* Update README.md

* Update README.md

* Update README.md

---------

Co-authored-by: Linlang <Lv.Linlang@hotmail.com>
This commit is contained in:
WinstonLiyt
2024-09-06 15:39:41 +08:00
committed by GitHub
parent fd8f371577
commit 0dc9247153
17 changed files with 217 additions and 156 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/_static/Framework-RDAgent.png
Vendored
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 339 KiB

docs/_static/demo.png
Vendored
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 567 KiB

docs/_static/favicon.ico
Vendored
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 3.8 KiB

docs/_static/logo.png
Vendored
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 94 KiB

docs/_static/scen.png
Vendored
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 303 KiB

docs/conf.py
+2
View File
@@ -61,7 +61,9 @@ try:
except ImportError:
html_theme = "default"
html_logo = "_static/logo.png"
html_static_path = ["_static"]
html_favicon = "_static/favicon.ico"
html_theme_options = {
"source_repository": "https://github.com/microsoft/RD-Agent",
docs/index.rst
+3
View File
@@ -6,6 +6,9 @@
Welcome to RDAgent's documentation!
===================================
.. image:: _static/logo.png
:alt: RD-Agent Logo
.. toctree::
:maxdepth: 3
:caption: Doctree:
docs/introduction.rst
+1 -1
View File
@@ -6,7 +6,7 @@ Introduction
In modern industry, research and development (R&D) is crucial for the enhancement of industrial productivity, especially in the AI era, where the core aspects of R&D are mainly focused on data and models. We are committed to automate these high-value generic R&D processes through our open source R&D automation tool RDAgent, which let AI drive data-driven AI.
.. image:: _static/scen.jpg
.. image:: _static/scen.png
:alt: Our focused scenario
docs/project_framework_introduction.rst
+1 -1
View File
@@ -7,7 +7,7 @@ Framework & Components
.. NOTE: This depends on the correctness of `c-v` of github.
.. image:: https://github.com/user-attachments/assets/98fce923-77ab-4982-93c8-a7a01aece766
.. image:: _static/Framework-RDAgent.png
:alt: Components & Feature Level
The image above shows the overall framework of RDAgent.
docs/scens/data_agent_fin.rst
+20 -15
View File
@@ -20,14 +20,14 @@ And this is where the **Finance Model Agent** comes into play.
🎥 `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>
<div style="display: flex; justify-content: center; align-items: center;">
<video width="600" controls>
<source src="https://rdagent.azurewebsites.net/media/65bb598f1372c1857ccbf09b2acf5d55830911625048c03102291098.mp4" type="video/mp4">
Your browser does not support the video tag.
</video>
</div>
🌟 Introduction
@@ -88,26 +88,31 @@ Please refer to the installation part in :doc:`../installation_and_configuration
You can try our demo by running the following command:
- 🐍 Create a Conda Environment
- Create a new conda environment with Python (3.10 and 3.11 are well tested in our CI):
.. code-block:: sh
- Create a new conda environment with Python (3.10 and 3.11 are well tested in our CI):
.. code-block:: sh
conda create -n rdagent python=3.10
- Activate the environment:
- Activate the environment:
.. code-block:: sh
.. code-block:: sh
conda activate rdagent
conda activate rdagent
- 📦 Install the RDAgent
- You can directly install the RDAgent package from PyPI:
- You can install the RDAgent package from PyPI:
.. code-block:: sh
.. code-block:: sh
pip install rdagent
pip install rdagent
- 🚀 Run the Application
- You can directly run the application by using the following command:
.. code-block:: sh
rdagent fin_factor
docs/scens/data_copilot_fin.rst
+47 -28
View File
@@ -25,11 +25,12 @@ And this is where the **Finance Data Copilot** steps in.
.. 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>
<div style="display: flex; justify-content: center; align-items: center;">
<video width="600" controls>
<source src="https://rdagent.azurewebsites.net/media/65bb598f1372c1857ccbf09b2acf5d55830911625048c03102291098.mp4" type="video/mp4">
Your browser does not support the video tag.
</video>
</div>
🌟 Introduction
@@ -88,41 +89,59 @@ Please refer to the installation part in :doc:`../installation_and_configuration
You can try our demo by running the following command:
- 🐍 Create a Conda Environment
- Create a new conda environment with Python (3.10 and 3.11 are well tested in our CI):
.. code-block:: sh
conda create -n rdagent python=3.10
- Create a new conda environment with Python (3.10 and 3.11 are well tested in our CI):
.. code-block:: sh
conda create -n rdagent python=3.10
- Activate the environment:
- Activate the environment:
.. code-block:: sh
.. code-block:: sh
conda activate rdagent
conda activate rdagent
- 📦 Install the RDAgent
- You can directly install the RDAgent package from PyPI:
- You can install the RDAgent package from PyPI:
.. code-block:: sh
.. code-block:: sh
pip install rdagent
pip install rdagent
- 🚀 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:
.. code-block:: json
[
"git_ignore_folder/report/fin_report1.pdf",
"git_ignore_folder/report/fin_report2.pdf",
"git_ignore_folder/report/fin_report3.pdf"
]
- Run the application using the following command:
.. code-block:: sh
- Download the financial reports you wish to extract factors from and store them in your preferred folder.
rdagent fin_factor_report
- Specifically, you can follow this example, or use your own method:
.. code-block:: sh
wget https://github.com/SunsetWolf/rdagent_resource/releases/download/reports/all_reports.zip
unzip all_reports.zip -d git_ignore_folder/reports
- Run the application with the following command:
.. code-block:: sh
rdagent fin_factor_report --report_folder=git_ignore_folder/reports
- Alternatively, you can store the paths of the reports in `report_result_json_file_path`. The format should be:
.. code-block:: json
[
"git_ignore_folder/report/fin_report1.pdf",
"git_ignore_folder/report/fin_report2.pdf",
"git_ignore_folder/report/fin_report3.pdf"
]
- Then, run the application using the following command:
.. code-block:: sh
rdagent fin_factor_report
🛠️ Usage of modules
~~~~~~~~~~~~~~~~~~~~~
docs/scens/model_agent_fin.rst
+21 -18
View File
@@ -22,14 +22,12 @@ And this is where the **Finance Model Agent** steps in.
.. 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>
<div style="display: flex; justify-content: center; align-items: center;">
<video width="600" controls>
<source src="https://rdagent.azurewebsites.net/media/65bb598f1372c1857ccbf09b2acf5d55830911625048c03102291098.mp4" type="video/mp4">
Your browser does not support the video tag.
</video>
</div>
🌟 Introduction
@@ -90,26 +88,31 @@ Please refer to the installation part in :doc:`../installation_and_configuration
You can try our demo by running the following command:
- 🐍 Create a Conda Environment
- Create a new conda environment with Python (3.10 and 3.11 are well tested in our CI):
- Create a new conda environment with Python (3.10 and 3.11 are well tested in our CI):
.. code-block:: sh
.. code-block:: sh
conda create -n rdagent python=3.10
conda create -n rdagent python=3.10
- Activate the environment:
- Activate the environment:
.. code-block:: sh
.. code-block:: sh
conda activate rdagent
conda activate rdagent
- 📦 Install the RDAgent
- You can directly install the RDAgent package from PyPI:
- You can install the RDAgent package from PyPI:
.. code-block:: sh
.. code-block:: sh
pip install rdagent
pip install rdagent
- 🚀 Run the Application
- You can directly run the application by using the following command:
.. code-block:: sh
rdagent fin_model
docs/scens/model_agent_med.rst
+25 -17
View File
@@ -17,10 +17,12 @@ In this task, we aim at predicting the whether the patients will suffer from Acu
.. 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>
<div style="display: flex; justify-content: center; align-items: center;">
<video width="600" controls>
<source src="https://rdagent.azurewebsites.net/media/65bb598f1372c1857ccbf09b2acf5d55830911625048c03102291098.mp4" type="video/mp4">
Your browser does not support the video tag.
</video>
</div>
🌟 Introduction
@@ -69,32 +71,38 @@ Please refer to the installation part in :doc:`../installation_and_configuration
You can try our demo by running the following command:
- 🐍 Create a Conda Environment
- Create a new conda environment with Python (3.10 and 3.11 are well tested in our CI):
- Create a new conda environment with Python (3.10 and 3.11 are well tested in our CI):
.. code-block:: sh
.. code-block:: sh
conda create -n rdagent python=3.10
conda create -n rdagent python=3.10
- Activate the environment:
- Activate the environment:
.. code-block:: sh
.. code-block:: sh
conda activate rdagent
conda activate rdagent
- 📦 Install the RDAgent
- You can directly install the RDAgent package from PyPI:
- You can install the RDAgent package from PyPI:
.. code-block:: sh
.. code-block:: sh
pip install rdagent
pip install rdagent
- 📦 Request PhysioNet Account
- Apply for an account at `PhysioNet <https://physionet.org/>`_.
- 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`.
- Apply for an account at `PhysioNet <https://physionet.org/>`_.
- 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`.
- 🚀 Run the Application
- You can directly run the application by using the following command:
.. code-block:: sh
rdagent med_model
docs/scens/model_copilot_general.rst
+26 -21
View File
@@ -20,10 +20,12 @@ And this is where the **General Model Copilot** steps in.
.. 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>
<div style="display: flex; justify-content: center; align-items: center;">
<video width="600" controls>
<source src="https://rdagent.azurewebsites.net/media/65bb598f1372c1857ccbf09b2acf5d55830911625048c03102291098.mp4" type="video/mp4">
Your browser does not support the video tag.
</video>
</div>
🌟 Introduction
~~~~~~~~~~~~~~~~
@@ -60,35 +62,38 @@ Please refer to the installation part in :doc:`../installation_and_configuration
You can try our demo by running the following command:
- 🐍 Create a Conda Environment
- Create a new conda environment with Python (3.10 and 3.11 are well tested in our CI):
- Create a new conda environment with Python (3.10 and 3.11 are well tested in our CI):
.. code-block:: sh
.. code-block:: sh
conda create -n rdagent python=3.10
conda create -n rdagent python=3.10
- Activate the environment:
- Activate the environment:
.. code-block:: sh
.. code-block:: sh
conda activate rdagent
conda activate rdagent
- 📦 Install the RDAgent
- You can directly install the RDAgent package from PyPI:
- You can install the RDAgent package from PyPI:
.. code-block:: sh
.. code-block:: sh
pip install rdagent
pip install rdagent
- 🚀 Run the Application
- Prepare relevant files (in pdf format) by uploading papers to the directory below and copy the path as report_file_path.
- Prepare relevant files (in pdf format) by uploading papers to the directory below and copy the path as report_file_path.
.. code-block:: sh
.. code-block:: sh
rdagent/scenarios/general_model
rdagent/scenarios/general_model
- Run the following command in your terminal within the same virtual environment:
.. code-block:: sh
- Run the following command in your terminal within the same virtual environment:
.. code-block:: sh
rdagent general_model --report_file_path=<path_to_pdf_file>
rdagent general_model --report_file_path=<path_to_pdf_file>