Skip to content
Snippets Groups Projects
Commit 6b43e12c authored by zqwerty's avatar zqwerty
Browse files

update README

parent 4e0a5de4
No related branches found
No related tags found
No related merge requests found
...@@ -20,7 +20,7 @@ ...@@ -20,7 +20,7 @@
## Installation ## 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) ### Git clone and pip install in development mode (Recommend)
...@@ -65,13 +65,15 @@ docker exec -it CONTAINER_ID bash ...@@ -65,13 +65,15 @@ docker exec -it CONTAINER_ID bash
## Tutorials ## 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)!) | Section | Description |
- [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) | [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)!) | |
- [How to add a new dataset](https://github.com/thu-coai/ConvLab-2/blob/master/tutorials/Add_New_Model.md) | [Unified Data Format](https://github.com/ConvLab/ConvLab-3/tree/master/data/unified_datasets) | |
- How to add a new model | [Utility functions for unified datasets](https://github.com/ConvLab/ConvLab-3/blob/master/convlab/util/unified_datasets_util.py) | |
- [How to use RL toolkit](https://github.com/thu-coai/ConvLab-2/blob/master/tutorials/Train_RL_Policies) | [RL Toolkit](https://github.com/ConvLab/ConvLab-3/tree/master/convlab/policy) | |
- [Interactive tool](https://github.com/thu-coai/ConvLab-2/blob/master/deploy) [[demo video]](https://youtu.be/00VWzbcx26E) | [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 ## Unified Datasets
...@@ -102,11 +104,11 @@ We list newly integrated models in ConvLab-3 that support unified data format an ...@@ -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 | | 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 | | 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 | | 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 | | 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, PPO, PG | State, DA-U, DB | DA-S | | 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 | | 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 | | 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). Trained models are available on [Hugging Face Hub](https://huggingface.co/ConvLab).
......
...@@ -24,7 +24,7 @@ setup( ...@@ -24,7 +24,7 @@ setup(
install_requires=[ install_requires=[
'joblib>=1.2.0', 'joblib>=1.2.0',
'pillow>=9.3.0', 'pillow>=9.3.0',
'protobuf>=3.19.5', 'protobuf>=3.20.2',
'oauthlib>=3.2.1', 'oauthlib>=3.2.1',
'accelerate', 'accelerate',
'rouge-score', 'rouge-score',
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment