An open API service indexing awesome lists of open source software.

https://github.com/allenai/prior

🐍 A Python Package for Seamless Data Distribution in AI Workflows
https://github.com/allenai/prior

ai2thor artificial-intelligence datasets deep-learning

Last synced: 9 months ago
JSON representation

🐍 A Python Package for Seamless Data Distribution in AI Workflows

Awesome Lists containing this project

README

          


🐍 PRIOR

A Python Package for Seamless Data Distribution in AI Workflows

![DALLΒ·E 2022-09-12 18 02 32 - A friendly green snake typing on a computer on the floor](https://user-images.githubusercontent.com/28768645/189784788-22986a02-d56e-4937-8c8e-e58685e8b72d.png)



DOI


License


GitHub release


Downloads

## 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")
```

- Object Nav Evaluation [[GitHub]](https://github.com/allenai/object-nav-eval)

```python
import prior
prior.load_dataset("object-nav-eval")
```

## Models

- ProcTHOR Models [[GitHub]](https://github.com/allenai/procthor-models)

```python
import prior
prior.load_model(project="procthor-models", model="object-nav-pretraining")
```

## 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=`). 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 = ""
```

## Citation

To cite the PRIOR package, please use:

```bibtex
@software{prior,
author={Matt Deitke and Aniruddha Kembhavi and Luca Weihs},
doi={10.5281/zenodo.7072830},
title={{PRIOR: A Python Package for Seamless Data Distribution in AI Workflows}},
url={https://github.com/allenai/prior},
year={2022}
}
```