Skip to content

Commit

Permalink
FIX: Update README file
Browse files Browse the repository at this point in the history
  • Loading branch information
Zilize committed Mar 28, 2021
1 parent 82daaf4 commit df4ed23
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 3 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ python run_crslab.py --config config/crs/kgsf/redial.yaml --save_data --save_sys
In summary, there are following arguments in `run_crslab.py`:

- `--config` or `-c`: relative path for configuration file(yaml).
- `--gpu` or `-g`: specify gpu id(s) to use, only support using a single gpu now. Defaults to cpu(-1).
- `--gpu` or `-g`: specify GPU id(s) to use, we now support multiple GPUs. Defaults to CPU(-1).
- `--save_data` or `-sd`: save pre-processed dataset.
- `--restore_data` or `-rd`: restore pre-processed dataset from file.
- `--save_system` or `-ss`: save trained system.
Expand Down Expand Up @@ -254,6 +254,8 @@ We welcome all contributions from bug fixes to new features and extensions.

We expect all contributions discussed in the issue tracker and going through PRs.

We thank the nice contributions through PRs from [@shubaoyu](https://github.com/shubaoyu), [@ToheartZhang](https://github.com/ToheartZhang).



## Citing
Expand Down
4 changes: 3 additions & 1 deletion README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ python run_crslab.py --config config/crs/kgsf/redial.yaml --save_data --save_sys
总的来说,`run_crslab.py`有如下参数可供调用:

- `--config``-c`:配置文件的相对路径,以指定运行的模型与数据集。
- `--gpu` or `-g`:指定 gpu id,目前仅支持单 GPU,默认使用 CPU(-1)。
- `--gpu` or `-g`:指定 GPU id,支持多 GPU,默认使用 CPU(-1)。
- `--save_data``-sd`:保存预处理的数据。
- `--restore_data``-rd`:从文件读取预处理的数据。
- `--save_system``-ss`:保存训练好的 CRS 系统。
Expand Down Expand Up @@ -259,6 +259,8 @@ python run_crslab.py --config config/crs/kgsf/redial.yaml --save_data --save_sys

如果想贡献代码,请先在 Issue 中提出问题,然后再提 PR。

我们感谢 [@shubaoyu](https://github.com/shubaoyu), [@ToheartZhang](https://github.com/ToheartZhang) 通过 PR 为项目贡献的新特性。



## 引用
Expand Down
2 changes: 1 addition & 1 deletion run_crslab.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
parser.add_argument('-c', '--config', type=str,
default='config/crs/tgredial/tgredial.yaml', help='config file(yaml) path')
parser.add_argument('-g', '--gpu', type=str, default='-1',
help='specify gpu id(s) to use, only support using a single gpu now. Defaults to cpu(-1).')
help='specify GPU id(s) to use, we now support multiple GPUs. Defaults to CPU(-1).')
parser.add_argument('-sd', '--save_data', action='store_true',
help='save processed dataset')
parser.add_argument('-rd', '--restore_data', action='store_true',
Expand Down

0 comments on commit df4ed23

Please sign in to comment.