Documentation
¶
Overview ¶
Package hf is the library behind the hf command line: the HTTP client, request shaping, and typed data models for Hugging Face.
The Client here is the spine every command shares. It sets a real User-Agent, paces requests so a busy session stays polite, and retries the transient failures (429 and 5xx) that any public API throws under load.
Index ¶
Constants ¶
const DefaultUserAgent = "hf/dev (+https://github.com/tamnd/hf-cli)"
DefaultUserAgent identifies the client to Hugging Face. A real, honest User-Agent is both polite and the thing most likely to keep you unblocked.
const Host = "huggingface.co"
Host is the site this client talks to, and the host the URI driver in domain.go claims.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
HTTP *http.Client
UserAgent string
// Rate is the minimum gap between requests. Zero means no pacing.
Rate time.Duration
Retries int
// contains filtered or unexported fields
}
Client talks to Hugging Face over HTTP.
func NewClient ¶
func NewClient() *Client
NewClient returns a Client with sensible defaults: a 30s timeout, a 200ms minimum gap between requests, and five retries on transient errors.
func (*Client) Get ¶
Get fetches url and returns the response body. It paces and retries according to the client's settings.
type Domain ¶
type Domain struct{}
Domain is the hf driver. It carries no state; the per-run client is built by the factory Register hands kit.
func (Domain) Info ¶
func (Domain) Info() kit.DomainInfo
Info describes the scheme, the hostnames a pasted link is matched against, and the identity reused for the binary's help and version.
type Paper ¶
type Paper struct {
ID string `json:"id" kit:"id" table:"id"`
Title string `json:"title" table:"title"`
Upvotes int `json:"upvotes" table:"upvotes"`
Authors []string `json:"authors" table:"authors"`
URL string `json:"url" table:"url,url"`
}
Paper holds the fields callers care about for a Hugging Face daily paper.
func (*Paper) AuthorsString ¶
AuthorsString returns the first 3 authors joined by ", ".
Source Files