huggingface

Documentation

Index

• Constants
• func AnalyzeAndPrintPermissions(cfg *config.Config, key string)
• type Analyzer
  • func (a Analyzer) Analyze(_ context.Context, credInfo map[string]string) (*analyzers.AnalyzerResult, error)
  • func (Analyzer) Type() analyzerpb.AnalyzerType
• type HFTokenJSON
• type Model
• type Permissions
• type SecretInfo
  • func AnalyzePermissions(cfg *config.Config, key string) (*SecretInfo, error)

Constants

const (
	FINEGRAINED = "fineGrained"
	WRITE       = "write"
	READ        = "read"
)

Functions

func AnalyzeAndPrintPermissions

func AnalyzeAndPrintPermissions(cfg *config.Config, key string)

AnalyzePermissions prints the permissions of a HuggingFace API key

Types

type Analyzer

type Analyzer struct {
	Cfg *config.Config
}

func (Analyzer) Analyze

func (a Analyzer) Analyze(_ context.Context, credInfo map[string]string) (*analyzers.AnalyzerResult, error)

func (Analyzer) Type

func (Analyzer) Type() analyzerpb.AnalyzerType

type HFTokenJSON

type HFTokenJSON struct {
	Username string `json:"name"`
	Name     string `json:"fullname"`
	Orgs     []struct {
		Name         string `json:"name"`
		Role         string `json:"roleInOrg"`
		IsEnterprise bool   `json:"isEnterprise"`
	} `json:"orgs"`
	Auth struct {
		AccessToken struct {
			Name        string `json:"displayName"`
			Type        string `json:"role"`
			CreatedAt   string `json:"createdAt"`
			FineGrained struct {
				Global []string `json:"global"`
				Scoped []struct {
					Entity struct {
						Type string `json:"type"`
						Name string `json:"name"`
						ID   string `json:"_id"`
					} `json:"entity"`
					Permissions []string `json:"permissions"`
				} `json:"scoped"`
			} `json:"fineGrained"`
		}
	} `json:"auth"`
}

HFTokenJSON is the struct for the HF /whoami-v2 API JSON response

type Model

type Model struct {
	Name        string `json:"id"`
	ID          string `json:"_id"`
	Private     bool   `json:"private"`
	Permissions Permissions
}

type Permissions

type Permissions struct {
	Read  bool
	Write bool
}

type SecretInfo

type SecretInfo struct {
	Token  HFTokenJSON
	Models []Model
}

func AnalyzePermissions

func AnalyzePermissions(cfg *config.Config, key string) (*SecretInfo, error)