Skip to content
Snippets Groups Projects
Unverified Commit 361551de authored by zhuqi's avatar zhuqi Committed by GitHub
Browse files

Merge pull request #84 from ConvLab/clean_code

update README
parents 16243e4c 6b43e12c
No related branches found
No related tags found
No related merge requests found
......@@ -20,7 +20,7 @@
## Installation
You can install ConvLab-3 in the following ways according to your need. Higher versions of `torch` and `transformers` may also work.
You can install ConvLab-3 in one of the following ways according to your need. Higher versions of `torch` and `transformers` may also work.
### Git clone and pip install in development mode (Recommend)
......@@ -65,13 +65,15 @@ docker exec -it CONTAINER_ID bash
## Tutorials
- [Getting Started](https://github.com/thu-coai/ConvLab-2/blob/master/tutorials/Getting_Started.ipynb) (Have a try on [Colab](https://colab.research.google.com/github/thu-coai/ConvLab-2/blob/master/tutorials/Getting_Started.ipynb)!)
- [Introduction to unified data format](https://github.com/ConvLab/ConvLab-3/tree/master/data/unified_datasets)
- [Utility functions for unified datasets](https://github.com/ConvLab/ConvLab-3/blob/master/convlab/util/unified_datasets_util.py)
- [How to add a new dataset](https://github.com/thu-coai/ConvLab-2/blob/master/tutorials/Add_New_Model.md)
- How to add a new model
- [How to use RL toolkit](https://github.com/thu-coai/ConvLab-2/blob/master/tutorials/Train_RL_Policies)
- [Interactive tool](https://github.com/thu-coai/ConvLab-2/blob/master/deploy) [[demo video]](https://youtu.be/00VWzbcx26E)
| Section | Description |
| ------------------------------------------------------------ | ----------- |
| [Getting Started](https://github.com/thu-coai/ConvLab-2/blob/master/tutorials/Getting_Started.ipynb) (Have a try on [Colab](https://colab.research.google.com/github/thu-coai/ConvLab-2/blob/master/tutorials/Getting_Started.ipynb)!) | |
| [Unified Data Format](https://github.com/ConvLab/ConvLab-3/tree/master/data/unified_datasets) | |
| [Utility functions for unified datasets](https://github.com/ConvLab/ConvLab-3/blob/master/convlab/util/unified_datasets_util.py) | |
| [RL Toolkit](https://github.com/ConvLab/ConvLab-3/tree/master/convlab/policy) | |
| [How to add a new dataset](https://github.com/thu-coai/ConvLab-2/blob/master/tutorials/Add_New_Model.md) | |
| How to add a new model | |
| [Interactive Tool](https://github.com/ConvLab/ConvLab-3/blob/master/deploy) [[demo video]](https://youtu.be/00VWzbcx26E) | |
## Unified Datasets
......@@ -102,11 +104,11 @@ We list newly integrated models in ConvLab-3 that support unified data format an
| Response Generation | [T5](https://github.com/ConvLab/ConvLab-3/tree/master/convlab/base_models/t5) | Context | Response |
| Goal-to-Dialogue | [T5](https://github.com/ConvLab/ConvLab-3/tree/master/convlab/base_models/t5) | Goal | Dialog |
| Natural Language Understanding | [T5](https://github.com/ConvLab/ConvLab-3/tree/master/convlab/base_models/t5), [BERTNLU](https://github.com/ConvLab/ConvLab-3/tree/master/convlab/nlu/jointBERT), [MILU](https://github.com/ConvLab/ConvLab-3/tree/master/convlab/nlu/milu) | Context | DA-U |
| Dialog State Tracking | [T5](https://github.com/ConvLab/ConvLab-3/tree/master/convlab/base_models/t5), SUMBT, SetSUMBT, TripPy | Context | State |
| RL Policy | DDPT, PPO, PG | State, DA-U, DB | DA-S |
| Dialog State Tracking | [T5](https://github.com/ConvLab/ConvLab-3/tree/master/convlab/base_models/t5), [SUMBT](https://github.com/ConvLab/ConvLab-3/tree/master/convlab/dst/sumbt), [SetSUMBT](https://github.com/ConvLab/ConvLab-3/tree/master/convlab/dst/setsumbt), TripPy | Context | State |
| RL Policy | [DDPT](https://github.com/ConvLab/ConvLab-3/tree/master/convlab/policy/vtrace_DPT), [PPO](https://github.com/ConvLab/ConvLab-3/tree/master/convlab/policy/ppo), [PG](https://github.com/ConvLab/ConvLab-3/tree/master/convlab/policy/pg) | State, DA-U, DB | DA-S |
| Natural Language Generation | [T5](https://github.com/ConvLab/ConvLab-3/tree/master/convlab/base_models/t5), SC-GPT | DA-S | Response |
| End-to-End | SOLOIST | Context, DB | State, Response |
| User simulator | TUS, GenTUS | Goal, DA-S | DA-U, (Response) |
| User simulator | [TUS](https://github.com/ConvLab/ConvLab-3/tree/master/convlab/policy/tus), [GenTUS](https://github.com/ConvLab/ConvLab-3/tree/master/convlab/policy/genTUS) | Goal, DA-S | DA-U, (Response) |
Trained models are available on [Hugging Face Hub](https://huggingface.co/ConvLab).
......
......@@ -24,7 +24,7 @@ setup(
install_requires=[
'joblib>=1.2.0',
'pillow>=9.3.0',
'protobuf>=3.19.5',
'protobuf>=3.20.2',
'oauthlib>=3.2.1',
'accelerate',
'rouge-score',
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment