The official weblinx library
Project description
WebLINX
🤗Dataset | 📄Paper | 🌐Website |
---|---|---|
🤖Models | 💻Explorer | 🐦Tweets |
WebLINX: Real-World Website Navigation with Multi-Turn Dialogue
Xing Han Lù*, Zdeněk Kasner*, Siva Reddy
*Equal contribution
Installation
# 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 for more information on how to use WebLINX.
Modeling
Our modeling code is separate from the weblinx
library, but requires it as a dependency. You can install the modeling code by running:
# First, install the base package
pip install weblinx
# THen, clone this repo
git clone https://github.com/McGill-NLP/weblinx
cd weblinx/modeling
For the rest of the instructions, please take a look at the modeling README.
Evaluation
To install packages necessary for evaluation, run:
pip install weblinx[eval]
You can now access the evaluation module by importing in Python:
import weblinx.eval
Use weblinx.eval.metrics
for evaluation metrics, weblinx.eval.__init__
for useful evaluation-related functions. You may also find it useful to take a look at weblinx.processing.outputs
to get an idea of how to use the outputs of the model for evaluation.
To run the automatic evaluation, you can use the following command:
python -m weblinx.eval --help
For more examples on how to use weblinx.eval
, take a look at the modeling README.
Note: We are still working on the code for
weblinx.eval
andweblinx.processing.outputs
. If you have any questions or would like to contribute docs, please feel free to open an issue or a pull request.
Citations
If you use this library, please cite our work using the following:
@misc{lù2024weblinx,
title={WebLINX: Real-World Website Navigation with Multi-Turn Dialogue},
author={Xing Han Lù and Zdeněk Kasner and Siva Reddy},
year={2024},
eprint={2402.05930},
archivePrefix={arXiv},
primaryClass={cs.CL}
}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.