AI4Finance-Foundation / AI4Finance-Foundation/FinRL-Meta

[Discussion] How to design the structure of tutorials with two versions (notebook and python)

Open
#134 4 comments 1 reaction 3 assignees Claimed by @zhumingpassional View on GitHub
discussion good first issue
Dominant language
Python
Stars
1.9k
Forks
751
PR merge metrics
No merged PRs in 30d

Description

We will provide tutorials with two versions, notebook and python. The python version will be more efficient to debug locally step by step. The notebook .ipynb can be obtained by directly copying from corresponding .py except the front install commands.

There may be several structures:
1. Like the current architecture in FinRL-Meta, tutorials_notebook and tutorials_python
2. tutorials -> 1-Introduction_notebook
1-Introduction_python
3. tutorials -> 1-Introduction -> FinRL_StockTrading_NeurIPS_2018 -> FinRL_StockTrading_NeurIPS_2018.py, FinRL_StockTrading_NeurIPS_2018.ipynb

Would you like to provide any ideas, or suggestions for the file structure? Moreover, the reasons of your suggestion are also welcome. Thanks very much.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.