Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
SunsetWolf committed Jun 27, 2024
1 parent 459af51 commit 0214b30
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 4 deletions.
4 changes: 2 additions & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ RUN python -m pip install importlib-metadata==5.2.0
RUN python -m pip install "cloudpickle<3"
RUN python -m pip install scikit-learn==1.3.2

RUN pip install cython packaging tables matplotlib statsmodels
RUN python -m pip install cython packaging tables matplotlib statsmodels

RUN python setup.py install
RUN python -m pip install pyqlib

EXPOSE 10050
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,25 @@ We recommend users to prepare their own data if they have a high-quality dataset
```
-->
## Build docker images
Running `build_docker_image.sh` is the right choice when you want to create a docker image for qlib. Of course, before running it, please open this file and make some necessary changes according to your docker hub account.
```bash
#!/bin/bash
# Build the Docker image
sudo docker build -t qlib_image -f ./Dockerfile .
# Log in to Docker Hub
# If you are a new docker hub user, please verify your email address before proceeding with this step.
sudo docker login
# Tag the Docker image
sudo docker tag qlib_image <Your docker hub username, not your email>/qlib_image:stable
# Push the Docker image to Docker Hub
sudo docker push <Your docker hub username, not your email>/qlib_image:stable
```
## Auto Quant Research Workflow
Qlib provides a tool named `qrun` to run the whole workflow automatically (including building dataset, training models, backtest and evaluation). You can start an auto quant research workflow and have a graphical reports analysis according to the following steps:
Expand Down
5 changes: 3 additions & 2 deletions build_docker_image.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@
sudo docker build -t qlib_image -f ./Dockerfile .

# Log in to Docker Hub
# If you are a new docker hub user, please verify your email address before proceeding with this step.
sudo docker login

# Tag the Docker image
sudo docker tag qlib_image linlanglv/qlib_image:stable
sudo docker tag qlib_image <Your docker hub username, not your email>/qlib_image:stable

# Push the Docker image to Docker Hub
sudo docker push linlanglv/qlib_image:stable
sudo docker push <Your docker hub username, not your email>/qlib_image:stable

0 comments on commit 0214b30

Please sign in to comment.