Metadata-Version: 2.1
Name: weblinx
Version: 0.1.0
Summary: The official weblinx library
Home-page: https://github.com/McGill-NLP/weblinx
Author: McGill NLP
Author-email: weblinx@googlegroups.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: tqdm
Provides-Extra: all
Requires-Dist: black ; extra == 'all'
Requires-Dist: wheel ; extra == 'all'
Requires-Dist: opencv-python-headless ; extra == 'all'
Requires-Dist: numpy ; extra == 'all'
Requires-Dist: Pillow ; extra == 'all'
Requires-Dist: lxml ; extra == 'all'
Provides-Extra: dev
Requires-Dist: black ; extra == 'dev'
Requires-Dist: wheel ; extra == 'dev'
Provides-Extra: processing
Requires-Dist: lxml ; extra == 'processing'
Provides-Extra: video
Requires-Dist: opencv-python-headless ; extra == 'video'
Requires-Dist: numpy ; extra == 'video'
Requires-Dist: Pillow ; extra == 'video'

<div align="center">

# 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_

<img src="./assets/webnav.demo.svg" width="80%" alt="Sample conversation between a user and an agent" />

</div>

### Installation

```bash
# Install the base package
pip install weblinx

# Install all dependencies
pip install weblinx[all]

# Install specific dependencies for...
# ...processing HTML
pip install weblinx[processing]
# ...video processing
pip install weblinx[video]
# ...development
pip install weblinx[dev]
```

### 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

Coming soon (mid-February)
