diff --git a/changelog.d/hf-token-request-docs.fixed.md b/changelog.d/hf-token-request-docs.fixed.md new file mode 100644 index 000000000..66028f409 --- /dev/null +++ b/changelog.d/hf-token-request-docs.fixed.md @@ -0,0 +1 @@ +Documented how to request access to restricted UK datasets before setting `HUGGING_FACE_TOKEN`. diff --git a/docs/book/usage/getting-started.md b/docs/book/usage/getting-started.md index 81a0155e3..404eb80d8 100644 --- a/docs/book/usage/getting-started.md +++ b/docs/book/usage/getting-started.md @@ -91,9 +91,14 @@ Policy parameters use a hierarchical structure - here we're changing the first U To analyse policies across the entire population, you'll need survey data. PolicyEngine provides processed datasets via HuggingFace, but you'll need an account and access token. ``` -1. Create a [HuggingFace account](https://huggingface.co) -2. Generate a personal access token in your settings -3. Set it as an environment variable: +1. Create a [HuggingFace account](https://huggingface.co). +2. If you need access to restricted UK datasets, first request access from PolicyEngine. Include your HuggingFace username and enough information to verify your licensed access to the underlying UK Data Service source data when you email [contact@policyengine.org](mailto:contact@policyengine.org). +3. Once access has been granted, generate a personal access token in your HuggingFace settings. +4. Set it as an environment variable: + +```{note} +PolicyEngine does not issue the token itself. We grant your HuggingFace account access to the private dataset repository, and you then create your own personal access token in HuggingFace. +``` ```bash export HUGGING_FACE_TOKEN=your_token_here @@ -200,4 +205,4 @@ The [PolicyEngine web app](https://policyengine.org) includes a 'Reproduce in Py For more detailed guidance, see: - [Simulations](simulations.md) - comprehensive guide to running simulations -- [Scenarios](scenarios.md) - creating and combining policy reforms \ No newline at end of file +- [Scenarios](scenarios.md) - creating and combining policy reforms