Skip to content

Commit

Permalink
Improve Readme (#1)
Browse files Browse the repository at this point in the history
* improve image

* change ratio

* Update readme with better design

* Add equal contribution

* Further improve readme

* add link to explorer
  • Loading branch information
xhluca authored Feb 8, 2024
1 parent 3f3cce6 commit 68e293e
Showing 1 changed file with 23 additions and 4 deletions.
27 changes: 23 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,34 @@
<div align="center">

# WebLINX

[Click here to access the official WebLINX website](https://mcgill-nlp.github.io/weblinx)
[**💻Code**](https://github.com/McGill-NLP/WebLINX) | **📄Paper (TBA)** | [**🌐Homepage**](https://mcgill-nlp.github.io/weblinx) | [**🤗Huggingface Data**](https://huggingface.co/datasets/McGill-NLP/WebLINX) | [💻Explorer App](https://huggingface.co/spaces/McGill-NLP/weblinx-explorer) | **🐦Tweets (TBA)** |
| :--: | :--: | :--: | :--: | :--: | :--: |


> **[WebLINX: Real-World Website Navigation with Multi-Turn Dialogue](https://mcgill-nlp.github.io/weblinx)**\
> *[Xing Han Lù*](https://xinghanlu.com), [Zdeněk Kasner*](https://kasnerz.github.io/), [Siva Reddy](https://sivareddy.in)*\
> _\*Equal contribution_
![image of the web navigation process](./assets/webnav.demo.svg)
<img src="./assets/webnav.demo.svg" width="80%" alt="Sample conversation between a user and an agent" />

</div>

### Installation

```bash
pip install weblinx
```

### Usage
### Library Usage

Check out our [documentation](https://mcgill-nlp.github.io/weblinx/docs) for more information on how to use WebLINX.


### Modeling

Coming soon (mid-February)

### Evaluation

Check out our [documentation](https://mcgill-nlp.github.io/weblinx/docs) for more information on how to use WebLINX.
Coming soon (mid-February)

0 comments on commit 68e293e

Please sign in to comment.