huggingface

Documentation

Overview

Code generated by go generate; DO NOT EDIT.

Index

• Constants
• Variables
• 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 Permission
  • func PermissionFromID(id int) (Permission, error)
  • func PermissionFromString(s string) (Permission, error)
  • func (p Permission) ToID() (int, error)
  • func (p Permission) ToString() (string, error)
• type Permissions
• type SecretInfo
  • func AnalyzePermissions(cfg *config.Config, key string) (*SecretInfo, error)

Constants

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

Variables

var (
	PermissionStrings = map[Permission]string{
		Read:  "read",
		Write: "write",
	}

	StringToPermission = map[string]Permission{
		"read":  Read,
		"write": Write,
	}

	PermissionIDs = map[Permission]int{
		Read:  1,
		Write: 2,
	}

	IdToPermission = map[int]Permission{
		1: Read,
		2: Write,
	}
)

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 Permission

type Permission int

const (
	Invalid Permission = iota
	Read    Permission = iota
	Write   Permission = iota
)

func PermissionFromID

func PermissionFromID(id int) (Permission, error)

PermissionFromID converts an ID to its Permission enum

func PermissionFromString

func PermissionFromString(s string) (Permission, error)

PermissionFromString converts a string representation to its Permission enum

func (Permission) ToID

func (p Permission) ToID() (int, error)

ToID converts a Permission enum to its ID

func (Permission) ToString

func (p Permission) ToString() (string, error)

ToString converts a Permission enum to its string representation

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)