hfup
- Version 1.0.4
- Published
- 183 kB
- 3 dependencies
- MIT license
Install
npm i hfupyarn add hfuppnpm add hfupOverview
A collection of tools to help you deploy, bundle HuggingFace Spaces and related assets with ease.
Index
Variables
Functions
Interfaces
Variables
variable baseModelRelationValues
const baseModelRelationValues: readonly [ 'finetune', 'adapter', 'merge', 'quantized'];variable LFS
const LFS: UnpluginInstance<Partial<LFSOptions>, false>;variable ModelCard
const ModelCard: UnpluginInstance<ModelCardOptions, false>;variable SpaceCard
const SpaceCard: UnpluginInstance<SpaceConfiguration & { root?: string }, false>;Functions
function generateGitAttributes
generateGitAttributes: (rawOptions?: Partial<LFSOptions>) => string;function generateModelCardReadme
generateModelCardReadme: (configurations?: ModelCardOptions) => Promise<string>;function generateSpaceCardReadme
generateSpaceCardReadme: (configurations?: SpaceCardOptions) => Promise<string>;function resolveLFSOptions
resolveLFSOptions: (rawOptions?: Partial<LFSOptions>) => LFSOptions;Interfaces
interface LFSOptions
interface LFSOptions {}property enableFn
enableFn: (ctx: LFSOptions) => boolean | Promise<boolean>;property extraAttributes
extraAttributes: string[];property extraGlobs
extraGlobs: string[];property root
root: string;property withDefault
withDefault: boolean;interface ModelCardConfiguration
interface ModelCardConfiguration {}property base_model
base_model?: string | string[];property base_model_relation
base_model_relation?: (typeof baseModelRelationValues)[number];property body
body?: string;property datasets
datasets?: string[];property language
language?: string[];property library_name
library_name?: string;property license
license?: License | 'other';property license_link
license_link?: string;property license_name
license_name?: string;property metadata
metadata?: Record<string, unknown>;property metrics
metrics?: string[];property model_name
model_name?: string;property new_version
new_version?: string;property pipeline_tag
pipeline_tag?: string;property sections
sections?: ModelCardSections;property tags
tags?: string[];property thumbnail
thumbnail?: string;property title
title?: string;interface ModelCardOptions
interface ModelCardOptions extends ModelCardConfiguration {}property root
root?: string;interface ModelCardSections
interface ModelCardSections {}property citation
citation?: string;property environmental_impact
environmental_impact?: string;property evaluation
evaluation?: string;property intended_uses
intended_uses?: string;property limitations
limitations?: string;property model_card_authors
model_card_authors?: string;property model_card_contact
model_card_contact?: string;property model_description
model_description?: string;property more_information
more_information?: string;property training_data
training_data?: string;interface SpaceCardOptions
interface SpaceCardOptions extends SpaceConfiguration {}property root
root?: string;Package Files (5)
Dependencies (3)
Dev Dependencies (11)
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this one
to your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/hfup.
- Markdown[](https://www.jsdocs.io/package/hfup)
- HTML<a href="https://www.jsdocs.io/package/hfup"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 2964 ms. - Missing or incorrect documentation? Open an issue for this package.