HF Hub Prompts

Prompts have become a key artifact for researchers and practitioners working with AI. There is, however, no standardized way of sharing prompts. Prompts are shared on the HF Hub in .txt files, in HF datasets, as strings in model cards, or on GitHub as python strings, in JSON, YAML, or in Jinja2.

Objectives and Non-Objectives of this library

Objectives

1. Provide a Python library that simplifies and standardises the sharing of prompts on the Hugging Face Hub.
2. Start an open discussion on the best way of standardizing and encouraging the sharing of prompts on the HF Hub, building upon the HF Hub's existing repository types and ensuring interoperability with other prompt-related libraries.

Non-Objectives:

• Compete with full-featured prompting libraries like LangChain, ell, etc. The objective is, instead, a simple solution for sharing prompts on the HF Hub, which is compatible with other libraries and which the community can build upon.

Quick Start

pip install hf-hub-prompts

For examples of the core functionality, see the docs.

Main use-case scenarios on the HF Hub

For use-case examples with all repository types on the Hugging Face Hub, see the docs.

The standardized YAML or JSON prompt template format

For a discussion of the standardized YAML or JSON prompt template format, see the docs.

TODO

• many things ...