From a0c83d7997d065ab6bf66a6670323df51fba88d2 Mon Sep 17 00:00:00 2001 From: you-n-g Date: Fri, 8 Jul 2022 10:16:08 +0800 Subject: [PATCH] Add introduction for workflow_by_code.py (#1186) * Update workflow_by_code.py * Update workflow_by_code.py --- examples/workflow_by_code.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/examples/workflow_by_code.py b/examples/workflow_by_code.py index da933b54e..0c4d73a51 100644 --- a/examples/workflow_by_code.py +++ b/examples/workflow_by_code.py @@ -1,6 +1,12 @@ # Copyright (c) Microsoft Corporation. # Licensed under the MIT License. +""" +Qlib provides two kinds of interfaces. +(1) Users could define the Quant research workflow by a simple configuration. +(2) Qlib is designed in a modularized way and supports creating research workflow by code just like building blocks. +The interface of (1) is `qrun XXX.yaml`. The interface of (2) is script like this, which nearly does the same thing as `qrun XXX.yaml` +""" import qlib from qlib.constant import REG_CN from qlib.utils import init_instance_by_config, flatten_dict