Metadata-Version: 2.1
Name: prior
Version: 0.0.1.dev27
Home-page: https://github.com/allenai/prior
Author: Allen Institute for Artificial Intelligence
Author-email: contact@allenai.org
License: Apache
Classifier: Intended Audience :: Science/Research
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: dev
License-File: LICENSE

# PRIOR

 🐍 A Python package for distributing resources from AI2's PRIOR team 

## Installation

Install the `prior` package with pip:

```bash
pip install prior
```

## Datasets

- ProcTHOR-10k [[GitHub]](https://github.com/allenai/procthor-10k)
```python
import prior
prior.load_dataset("procthor-10k")
```

_More coming soon!_

## Example Usage

To use a public Python dataset, simply run:

```python
import prior
dataset = prior.load_dataset("test-dataset", entity="mattdeitke", revision="main")
```
Here, `revision` can be either a tag, branch, or commit hash.

## Private Datasets

If you want to use a private dataset, make sure you're either:
1. Already logged into GitHub from the command line, and able to pull a private repo.
2. Set the GITHUB_TOKEN environment variable to a GitHub authentication token with read access to private repositories (e.g., `export GITHUB_TOKEN=<token>`). You can generate a GitHub authentication token [here](https://github.com/settings/tokens).
3. Set the `gh_auth_token` global variable in the `prior` package with:
```python
import prior
prior.gh_auth_token = "<token>"
```
