Skip to content

Commit

Permalink
Update README.md citations
Browse files Browse the repository at this point in the history
  • Loading branch information
xhluca authored Jul 15, 2024
1 parent afd193d commit d9e71ef
Showing 1 changed file with 49 additions and 9 deletions.
58 changes: 49 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,34 @@
| Deployment | We want to make it easy to integrate Llama models with existing deployment platforms, including Playwright, Selenium, and BrowserGym. We are currently focusing on making this a reality. |


<details>
<summary>Click to show citation</summary><br>

If you use `WebLlama` in your research, you can cite the ICML 2024 paper upon which the training and evaluation are originally based on, by adding the following to your bibtex file:

```
@misc{lu_2024_weblinx,
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}
}
```

Example usage (in latex):

```
We use the WebLlama library, which builds on top of WebLINX \citep{lu_2024_weblinx}.
```

```
We use Llama-3-8B-Web, a model finetuned on WebLINX demonstrations \citep{lu_2024_weblinx}.
```

</details>

## Modeling

> [!NOTE]
Expand Down Expand Up @@ -113,12 +141,24 @@ The code for finetuning the model and evaluating it on the [`WebLINX`](https://m
> 👷‍♀️ **Next steps**\
> We are actively working on new data and evaluation at the moment! If you want to help, please create an issue describing what you would like to contribute, and we will be happy to help you get started.

## License

The code in this repository is licensed under the MIT license, unless otherwise specified in the header of the file. Other materials (models, data, images) have their own licenses, which are specified in the original pages.

## FAQ

### How can I contribute to the project?

We are actively looking for collaborators to help us build the best Llama-3 web agents! To get started, open an issue about what you would like to contribute, and once it has been discussed, you can submit a pull request.


## Citation

If you use `WebLlama` in your research, please cite the following paper (upon which the data, training and evaluation are originally based on):
If you use `WebLlama` in your research, you can cite the ICML 2024 paper upon which the training and evaluation are originally based on, by adding the following to your bibtex file:

```
@misc{lù2024weblinx,
@misc{lu_2024_weblinx,
title={WebLINX: Real-World Website Navigation with Multi-Turn Dialogue},
author={Xing Han Lù and Zdeněk Kasner and Siva Reddy},
year={2024},
Expand All @@ -128,12 +168,12 @@ If you use `WebLlama` in your research, please cite the following paper (upon wh
}
```

## License
Example usage (in latex):

The code in this repository is licensed under the MIT license, unless otherwise specified in the header of the file. Other materials (models, data, images) have their own licenses, which are specified in the original pages.

## FAQ

### How can I contribute to the project?
```
We use the WebLlama library, which builds on top of WebLINX \citep{lu_2024_weblinx}.
```

We are actively looking for collaborators to help us build the best Llama-3 web agents! To get started, open an issue about what you would like to contribute, and once it has been discussed, you can submit a pull request.
```
We use Llama-3-8B-Web, a model finetuned on WebLINX demonstrations \citep{lu_2024_weblinx}.
```

0 comments on commit d9e71ef

Please sign in to comment.