|
-
- <!doctype html>
- <html lang="en" class="no-js">
- <head>
-
- <meta charset="utf-8">
- <meta name="viewport" content="width=device-width,initial-scale=1">
-
-
-
-
- <link rel="prev" href="../llama.native.safellamamodelhandle/">
-
-
- <link rel="next" href="../llama.oldversion.chatcompletion/">
-
- <link rel="icon" href="../../assets/images/favicon.png">
- <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.16">
-
-
-
- <title>llama.native.samplingapi - LLamaSharp Documentation</title>
-
-
-
- <link rel="stylesheet" href="../../assets/stylesheets/main.26e3688c.min.css">
-
-
-
-
-
-
-
-
-
- <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
- <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
- <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
-
-
-
- <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
-
-
-
-
-
-
- </head>
-
-
- <body dir="ltr">
-
-
-
- <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
-
- <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
- <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
- <label class="md-overlay" for="__drawer"></label>
- <div data-md-component="skip">
-
-
- <a href="#samplingapi" class="md-skip">
- Skip to content
- </a>
-
- </div>
- <div data-md-component="announce">
-
- </div>
-
- <div data-md-color-scheme="default" data-md-component="outdated" hidden>
-
- </div>
-
-
-
-
-
-
- <header class="md-header md-header--shadow" data-md-component="header">
- <nav class="md-header__inner md-grid" aria-label="Header">
- <a href="../.." title="LLamaSharp Documentation" class="md-header__button md-logo" aria-label="LLamaSharp Documentation" data-md-component="logo">
-
-
- <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
-
- </a>
- <label class="md-header__button md-icon" for="__drawer">
- <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
- </label>
- <div class="md-header__title" data-md-component="header-title">
- <div class="md-header__ellipsis">
- <div class="md-header__topic">
- <span class="md-ellipsis">
- LLamaSharp Documentation
- </span>
- </div>
- <div class="md-header__topic" data-md-component="header-topic">
- <span class="md-ellipsis">
-
- llama.native.samplingapi
-
- </span>
- </div>
- </div>
- </div>
-
-
-
- <label class="md-header__button md-icon" for="__search">
- <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
- </label>
- <div class="md-search" data-md-component="search" role="dialog">
- <label class="md-search__overlay" for="__search"></label>
- <div class="md-search__inner" role="search">
- <form class="md-search__form" name="search">
- <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
- <label class="md-search__icon md-icon" for="__search">
- <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
- <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
- </label>
- <nav class="md-search__options" aria-label="Search">
-
- <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
- <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
- </button>
- </nav>
-
- </form>
- <div class="md-search__output">
- <div class="md-search__scrollwrap" data-md-scrollfix>
- <div class="md-search-result" data-md-component="search-result">
- <div class="md-search-result__meta">
- Initializing search
- </div>
- <ol class="md-search-result__list" role="presentation"></ol>
- </div>
- </div>
- </div>
- </div>
- </div>
-
-
- </nav>
-
- </header>
-
- <div class="md-container" data-md-component="container">
-
-
-
-
-
-
- <main class="md-main" data-md-component="main">
- <div class="md-main__inner md-grid">
-
-
-
- <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
- <div class="md-sidebar__scrollwrap">
- <div class="md-sidebar__inner">
-
-
-
- <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
- <label class="md-nav__title" for="__drawer">
- <a href="../.." title="LLamaSharp Documentation" class="md-nav__button md-logo" aria-label="LLamaSharp Documentation" data-md-component="logo">
-
-
- <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
-
- </a>
- LLamaSharp Documentation
- </label>
-
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../.." class="md-nav__link">
- Overview
- </a>
- </li>
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../GetStarted/" class="md-nav__link">
- Get Started
- </a>
- </li>
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../Architecture/" class="md-nav__link">
- Architecture
- </a>
- </li>
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../Tricks/" class="md-nav__link">
- Tricks for FAQ
- </a>
- </li>
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../ContributingGuide/" class="md-nav__link">
- Contributing Guide
- </a>
- </li>
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
- <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
-
-
-
- <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
- LLamaContext
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_6">
- <span class="md-nav__icon md-icon"></span>
- LLamaContext
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../LLamaContext/parameters.md" class="md-nav__link">
- Context Parameters
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../LLamaContext/tokenization.md" class="md-nav__link">
- Tokenization
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../LLamaContext/embeddings.md" class="md-nav__link">
- Get Embeddings
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../LLamaContext/quantization.md" class="md-nav__link">
- Quantization
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../LLamaContext/save-load-state.md" class="md-nav__link">
- Save/Load State
- </a>
- </li>
-
-
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
- <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
-
-
-
- <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
- LLamaExecutors
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_7">
- <span class="md-nav__icon md-icon"></span>
- LLamaExecutors
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../LLamaExecutors/parameters/" class="md-nav__link">
- Inference Parameters
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../LLamaExecutors/text-to-text-apis/" class="md-nav__link">
- Text-to-Text APIs
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../LLamaExecutors/save-load-state/" class="md-nav__link">
- Save/Load State
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../LLamaExecutors/differences/" class="md-nav__link">
- Differences of Executors
- </a>
- </li>
-
-
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
- <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" >
-
-
-
- <label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
- ChatSession
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_8">
- <span class="md-nav__icon md-icon"></span>
- ChatSession
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../ChatSession/basic-usages/" class="md-nav__link">
- Basic Usages
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../ChatSession/transforms/" class="md-nav__link">
- Transoforms
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../ChatSession/save-load-session/" class="md-nav__link">
- Save/Load Session
- </a>
- </li>
-
-
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
- <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9" >
-
-
-
- <label class="md-nav__link" for="__nav_9" id="__nav_9_label" tabindex="0">
- Non-English Usages
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_9">
- <span class="md-nav__icon md-icon"></span>
- Non-English Usages
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../NonEnglishUsage/Chinese/" class="md-nav__link">
- Chinese
- </a>
- </li>
-
-
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
- <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10" >
-
-
-
- <label class="md-nav__link" for="__nav_10" id="__nav_10_label" tabindex="0">
- High-level Applications
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_10">
- <span class="md-nav__icon md-icon"></span>
- High-level Applications
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../HighLevelApps/bot-sharp/" class="md-nav__link">
- BotSharp
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../HighLevelApps/semantic-kernel/" class="md-nav__link">
- semantic-kernel
- </a>
- </li>
-
-
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
- <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_11" >
-
-
-
- <label class="md-nav__link" for="__nav_11" id="__nav_11_label" tabindex="0">
- More
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_11">
- <span class="md-nav__icon md-icon"></span>
- More
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../More/log/" class="md-nav__link">
- Logger
- </a>
- </li>
-
-
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
-
-
- <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_12" >
-
-
-
- <label class="md-nav__link" for="__nav_12" id="__nav_12_label" tabindex="0">
- Examples
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_12_label" aria-expanded="false">
- <label class="md-nav__title" for="__nav_12">
- <span class="md-nav__icon md-icon"></span>
- Examples
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../Examples/ChatSessionStripRoleName/" class="md-nav__link">
- Chat session 1
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../Examples/ChatSessionWithRoleName/" class="md-nav__link">
- Chat session 2
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../Examples/GetEmbeddings/" class="md-nav__link">
- Get embeddings
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../Examples/InstructModeExecute/" class="md-nav__link">
- Instruct executor
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../Examples/InteractiveModeExecute/" class="md-nav__link">
- Interactive executor
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../Examples/StatelessModeExecute/" class="md-nav__link">
- Stateless exeutor
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../Examples/LoadAndSaveSession/" class="md-nav__link">
- Load/Save session
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../Examples/LoadAndSaveState/" class="md-nav__link">
- Load/Save state
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../../Examples/QuantizeModel/" class="md-nav__link">
- Quantize model
- </a>
- </li>
-
-
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--active md-nav__item--nested">
-
-
-
-
- <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_13" checked>
-
-
-
- <label class="md-nav__link" for="__nav_13" id="__nav_13_label" tabindex="0">
- API Reference
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_13_label" aria-expanded="true">
- <label class="md-nav__title" for="__nav_13">
- <span class="md-nav__icon md-icon"></span>
- API Reference
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../" class="md-nav__link">
- index
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.abstractions.ihistorytransform/" class="md-nav__link">
- llama.abstractions.ihistorytransform
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.abstractions.iinferenceparams/" class="md-nav__link">
- llama.abstractions.iinferenceparams
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.abstractions.illamaexecutor/" class="md-nav__link">
- llama.abstractions.illamaexecutor
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.abstractions.imodelparams/" class="md-nav__link">
- llama.abstractions.imodelparams
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.abstractions.itextstreamtransform/" class="md-nav__link">
- llama.abstractions.itextstreamtransform
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.abstractions.itexttransform/" class="md-nav__link">
- llama.abstractions.itexttransform
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.chatsession/" class="md-nav__link">
- llama.chatsession
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.common.authorrole/" class="md-nav__link">
- llama.common.authorrole
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.common.chathistory/" class="md-nav__link">
- llama.common.chathistory
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.common.fixedsizequeue-1/" class="md-nav__link">
- llama.common.fixedsizequeue-1
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.common.illamalogger/" class="md-nav__link">
- llama.common.illamalogger
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.common.inferenceparams/" class="md-nav__link">
- llama.common.inferenceparams
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.common.llamadefaultlogger/" class="md-nav__link">
- llama.common.llamadefaultlogger
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.common.mirostattype/" class="md-nav__link">
- llama.common.mirostattype
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.common.modelparams/" class="md-nav__link">
- llama.common.modelparams
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.exceptions.grammarexpectedname/" class="md-nav__link">
- llama.exceptions.grammarexpectedname
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.exceptions.grammarexpectednext/" class="md-nav__link">
- llama.exceptions.grammarexpectednext
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.exceptions.grammarexpectedprevious/" class="md-nav__link">
- llama.exceptions.grammarexpectedprevious
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.exceptions.grammarformatexception/" class="md-nav__link">
- llama.exceptions.grammarformatexception
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.exceptions.grammarunexpectedcharaltelement/" class="md-nav__link">
- llama.exceptions.grammarunexpectedcharaltelement
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.exceptions.grammarunexpectedcharrngelement/" class="md-nav__link">
- llama.exceptions.grammarunexpectedcharrngelement
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.exceptions.grammarunexpectedendelement/" class="md-nav__link">
- llama.exceptions.grammarunexpectedendelement
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.exceptions.grammarunexpectedendofinput/" class="md-nav__link">
- llama.exceptions.grammarunexpectedendofinput
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.exceptions.grammarunexpectedhexcharscount/" class="md-nav__link">
- llama.exceptions.grammarunexpectedhexcharscount
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.exceptions.grammarunknownescapecharacter/" class="md-nav__link">
- llama.exceptions.grammarunknownescapecharacter
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.exceptions.runtimeerror/" class="md-nav__link">
- llama.exceptions.runtimeerror
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.extensions.imodelparamsextensions/" class="md-nav__link">
- llama.extensions.imodelparamsextensions
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.extensions.keyvaluepairextensions/" class="md-nav__link">
- llama.extensions.keyvaluepairextensions
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.grammars.grammar/" class="md-nav__link">
- llama.grammars.grammar
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.grammars.grammarrule/" class="md-nav__link">
- llama.grammars.grammarrule
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.instructexecutor/" class="md-nav__link">
- llama.instructexecutor
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.interactiveexecutor/" class="md-nav__link">
- llama.interactiveexecutor
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.llamacontext/" class="md-nav__link">
- llama.llamacontext
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.llamaembedder/" class="md-nav__link">
- llama.llamaembedder
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.llamaquantizer/" class="md-nav__link">
- llama.llamaquantizer
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.llamatransforms/" class="md-nav__link">
- llama.llamatransforms
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.llamaweights/" class="md-nav__link">
- llama.llamaweights
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.native.llamacontextparams/" class="md-nav__link">
- llama.native.llamacontextparams
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.native.llamaftype/" class="md-nav__link">
- llama.native.llamaftype
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.native.llamagrammarelement/" class="md-nav__link">
- llama.native.llamagrammarelement
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.native.llamagrammarelementtype/" class="md-nav__link">
- llama.native.llamagrammarelementtype
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.native.llamamodelquantizeparams/" class="md-nav__link">
- llama.native.llamamodelquantizeparams
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.native.llamatokendata/" class="md-nav__link">
- llama.native.llamatokendata
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.native.llamatokendataarray/" class="md-nav__link">
- llama.native.llamatokendataarray
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.native.llamatokendataarraynative/" class="md-nav__link">
- llama.native.llamatokendataarraynative
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.native.nativeapi/" class="md-nav__link">
- llama.native.nativeapi
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.native.safellamacontexthandle/" class="md-nav__link">
- llama.native.safellamacontexthandle
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.native.safellamagrammarhandle/" class="md-nav__link">
- llama.native.safellamagrammarhandle
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.native.safellamahandlebase/" class="md-nav__link">
- llama.native.safellamahandlebase
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.native.safellamamodelhandle/" class="md-nav__link">
- llama.native.safellamamodelhandle
- </a>
- </li>
-
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--active">
-
- <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
-
-
-
-
-
- <label class="md-nav__link md-nav__link--active" for="__toc">
- llama.native.samplingapi
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <a href="./" class="md-nav__link md-nav__link--active">
- llama.native.samplingapi
- </a>
-
-
-
- <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
-
-
-
-
-
-
- <label class="md-nav__title" for="__toc">
- <span class="md-nav__icon md-icon"></span>
- Table of contents
- </label>
- <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
-
- <li class="md-nav__item">
- <a href="#constructors" class="md-nav__link">
- Constructors
- </a>
-
- <nav class="md-nav" aria-label="Constructors">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#samplingapi_1" class="md-nav__link">
- SamplingApi()
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#methods" class="md-nav__link">
- Methods
- </a>
-
- <nav class="md-nav" aria-label="Methods">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#llama_sample_grammarsafellamacontexthandle-llamatokendataarray-safellamagrammarhandle" class="md-nav__link">
- llama_sample_grammar(SafeLLamaContextHandle, LLamaTokenDataArray, SafeLLamaGrammarHandle)
- </a>
-
- <nav class="md-nav" aria-label="llama_sample_grammar(SafeLLamaContextHandle, LLamaTokenDataArray, SafeLLamaGrammarHandle)">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#parameters" class="md-nav__link">
- Parameters
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#llama_sample_repetition_penaltysafellamacontexthandle-llamatokendataarray-memoryint32-uint64-single" class="md-nav__link">
- llama_sample_repetition_penalty(SafeLLamaContextHandle, LLamaTokenDataArray, Memory<Int32>, UInt64, Single)
- </a>
-
- <nav class="md-nav" aria-label="llama_sample_repetition_penalty(SafeLLamaContextHandle, LLamaTokenDataArray, Memory<Int32>, UInt64, Single)">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#caution" class="md-nav__link">
- Caution
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#parameters_1" class="md-nav__link">
- Parameters
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#llama_sample_repetition_penaltysafellamacontexthandle-llamatokendataarray-memoryint32-single" class="md-nav__link">
- llama_sample_repetition_penalty(SafeLLamaContextHandle, LLamaTokenDataArray, Memory<Int32>, Single)
- </a>
-
- <nav class="md-nav" aria-label="llama_sample_repetition_penalty(SafeLLamaContextHandle, LLamaTokenDataArray, Memory<Int32>, Single)">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#parameters_2" class="md-nav__link">
- Parameters
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#llama_sample_frequency_and_presence_penaltiessafellamacontexthandle-llamatokendataarray-memoryint32-uint64-single-single" class="md-nav__link">
- llama_sample_frequency_and_presence_penalties(SafeLLamaContextHandle, LLamaTokenDataArray, Memory<Int32>, UInt64, Single, Single)
- </a>
-
- <nav class="md-nav" aria-label="llama_sample_frequency_and_presence_penalties(SafeLLamaContextHandle, LLamaTokenDataArray, Memory<Int32>, UInt64, Single, Single)">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#caution_1" class="md-nav__link">
- Caution
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#parameters_3" class="md-nav__link">
- Parameters
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#llama_sample_frequency_and_presence_penaltiessafellamacontexthandle-llamatokendataarray-memoryint32-single-single" class="md-nav__link">
- llama_sample_frequency_and_presence_penalties(SafeLLamaContextHandle, LLamaTokenDataArray, Memory<Int32>, Single, Single)
- </a>
-
- <nav class="md-nav" aria-label="llama_sample_frequency_and_presence_penalties(SafeLLamaContextHandle, LLamaTokenDataArray, Memory<Int32>, Single, Single)">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#parameters_4" class="md-nav__link">
- Parameters
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#llama_sample_softmaxsafellamacontexthandle-llamatokendataarray" class="md-nav__link">
- llama_sample_softmax(SafeLLamaContextHandle, LLamaTokenDataArray)
- </a>
-
- <nav class="md-nav" aria-label="llama_sample_softmax(SafeLLamaContextHandle, LLamaTokenDataArray)">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#parameters_5" class="md-nav__link">
- Parameters
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#llama_sample_top_ksafellamacontexthandle-llamatokendataarray-int32-uint64" class="md-nav__link">
- llama_sample_top_k(SafeLLamaContextHandle, LLamaTokenDataArray, Int32, UInt64)
- </a>
-
- <nav class="md-nav" aria-label="llama_sample_top_k(SafeLLamaContextHandle, LLamaTokenDataArray, Int32, UInt64)">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#parameters_6" class="md-nav__link">
- Parameters
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#llama_sample_top_psafellamacontexthandle-llamatokendataarray-single-uint64" class="md-nav__link">
- llama_sample_top_p(SafeLLamaContextHandle, LLamaTokenDataArray, Single, UInt64)
- </a>
-
- <nav class="md-nav" aria-label="llama_sample_top_p(SafeLLamaContextHandle, LLamaTokenDataArray, Single, UInt64)">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#parameters_7" class="md-nav__link">
- Parameters
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#llama_sample_tail_freesafellamacontexthandle-llamatokendataarray-single-uint64" class="md-nav__link">
- llama_sample_tail_free(SafeLLamaContextHandle, LLamaTokenDataArray, Single, UInt64)
- </a>
-
- <nav class="md-nav" aria-label="llama_sample_tail_free(SafeLLamaContextHandle, LLamaTokenDataArray, Single, UInt64)">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#parameters_8" class="md-nav__link">
- Parameters
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#llama_sample_typicalsafellamacontexthandle-llamatokendataarray-single-uint64" class="md-nav__link">
- llama_sample_typical(SafeLLamaContextHandle, LLamaTokenDataArray, Single, UInt64)
- </a>
-
- <nav class="md-nav" aria-label="llama_sample_typical(SafeLLamaContextHandle, LLamaTokenDataArray, Single, UInt64)">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#parameters_9" class="md-nav__link">
- Parameters
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#llama_sample_temperaturesafellamacontexthandle-llamatokendataarray-single" class="md-nav__link">
- llama_sample_temperature(SafeLLamaContextHandle, LLamaTokenDataArray, Single)
- </a>
-
- <nav class="md-nav" aria-label="llama_sample_temperature(SafeLLamaContextHandle, LLamaTokenDataArray, Single)">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#parameters_10" class="md-nav__link">
- Parameters
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#llama_sample_token_mirostatsafellamacontexthandle-llamatokendataarray-single-single-int32-single" class="md-nav__link">
- llama_sample_token_mirostat(SafeLLamaContextHandle, LLamaTokenDataArray, Single, Single, Int32, Single&)
- </a>
-
- <nav class="md-nav" aria-label="llama_sample_token_mirostat(SafeLLamaContextHandle, LLamaTokenDataArray, Single, Single, Int32, Single&)">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#parameters_11" class="md-nav__link">
- Parameters
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#returns" class="md-nav__link">
- Returns
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#llama_sample_token_mirostat_v2safellamacontexthandle-llamatokendataarray-single-single-single" class="md-nav__link">
- llama_sample_token_mirostat_v2(SafeLLamaContextHandle, LLamaTokenDataArray, Single, Single, Single&)
- </a>
-
- <nav class="md-nav" aria-label="llama_sample_token_mirostat_v2(SafeLLamaContextHandle, LLamaTokenDataArray, Single, Single, Single&)">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#parameters_12" class="md-nav__link">
- Parameters
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#returns_1" class="md-nav__link">
- Returns
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#llama_sample_token_greedysafellamacontexthandle-llamatokendataarray" class="md-nav__link">
- llama_sample_token_greedy(SafeLLamaContextHandle, LLamaTokenDataArray)
- </a>
-
- <nav class="md-nav" aria-label="llama_sample_token_greedy(SafeLLamaContextHandle, LLamaTokenDataArray)">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#parameters_13" class="md-nav__link">
- Parameters
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#returns_2" class="md-nav__link">
- Returns
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#llama_sample_tokensafellamacontexthandle-llamatokendataarray" class="md-nav__link">
- llama_sample_token(SafeLLamaContextHandle, LLamaTokenDataArray)
- </a>
-
- <nav class="md-nav" aria-label="llama_sample_token(SafeLLamaContextHandle, LLamaTokenDataArray)">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#parameters_14" class="md-nav__link">
- Parameters
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#returns_3" class="md-nav__link">
- Returns
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- </ul>
-
- </nav>
-
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.oldversion.chatcompletion/" class="md-nav__link">
- llama.oldversion.chatcompletion
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.oldversion.chatcompletionchoice/" class="md-nav__link">
- llama.oldversion.chatcompletionchoice
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.oldversion.chatcompletionchunk/" class="md-nav__link">
- llama.oldversion.chatcompletionchunk
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.oldversion.chatcompletionchunkchoice/" class="md-nav__link">
- llama.oldversion.chatcompletionchunkchoice
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.oldversion.chatcompletionchunkdelta/" class="md-nav__link">
- llama.oldversion.chatcompletionchunkdelta
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.oldversion.chatcompletionmessage/" class="md-nav__link">
- llama.oldversion.chatcompletionmessage
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.oldversion.chatmessagerecord/" class="md-nav__link">
- llama.oldversion.chatmessagerecord
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.oldversion.chatrole/" class="md-nav__link">
- llama.oldversion.chatrole
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.oldversion.chatsession-1/" class="md-nav__link">
- llama.oldversion.chatsession-1
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.oldversion.completion/" class="md-nav__link">
- llama.oldversion.completion
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.oldversion.completionchoice/" class="md-nav__link">
- llama.oldversion.completionchoice
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.oldversion.completionchunk/" class="md-nav__link">
- llama.oldversion.completionchunk
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.oldversion.completionlogprobs/" class="md-nav__link">
- llama.oldversion.completionlogprobs
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.oldversion.completionusage/" class="md-nav__link">
- llama.oldversion.completionusage
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.oldversion.embedding/" class="md-nav__link">
- llama.oldversion.embedding
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.oldversion.embeddingdata/" class="md-nav__link">
- llama.oldversion.embeddingdata
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.oldversion.embeddingusage/" class="md-nav__link">
- llama.oldversion.embeddingusage
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.oldversion.ichatmodel/" class="md-nav__link">
- llama.oldversion.ichatmodel
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.oldversion.llamaembedder/" class="md-nav__link">
- llama.oldversion.llamaembedder
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.oldversion.llamamodel/" class="md-nav__link">
- llama.oldversion.llamamodel
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.oldversion.llamaparams/" class="md-nav__link">
- llama.oldversion.llamaparams
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.statefulexecutorbase/" class="md-nav__link">
- llama.statefulexecutorbase
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.statelessexecutor/" class="md-nav__link">
- llama.statelessexecutor
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../llama.utils/" class="md-nav__link">
- llama.utils
- </a>
- </li>
-
-
-
-
- </ul>
- </nav>
- </li>
-
-
-
- </ul>
- </nav>
- </div>
- </div>
- </div>
-
-
-
- <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
- <div class="md-sidebar__scrollwrap">
- <div class="md-sidebar__inner">
-
-
- <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
-
-
-
-
-
-
- <label class="md-nav__title" for="__toc">
- <span class="md-nav__icon md-icon"></span>
- Table of contents
- </label>
- <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
-
- <li class="md-nav__item">
- <a href="#constructors" class="md-nav__link">
- Constructors
- </a>
-
- <nav class="md-nav" aria-label="Constructors">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#samplingapi_1" class="md-nav__link">
- SamplingApi()
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#methods" class="md-nav__link">
- Methods
- </a>
-
- <nav class="md-nav" aria-label="Methods">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#llama_sample_grammarsafellamacontexthandle-llamatokendataarray-safellamagrammarhandle" class="md-nav__link">
- llama_sample_grammar(SafeLLamaContextHandle, LLamaTokenDataArray, SafeLLamaGrammarHandle)
- </a>
-
- <nav class="md-nav" aria-label="llama_sample_grammar(SafeLLamaContextHandle, LLamaTokenDataArray, SafeLLamaGrammarHandle)">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#parameters" class="md-nav__link">
- Parameters
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#llama_sample_repetition_penaltysafellamacontexthandle-llamatokendataarray-memoryint32-uint64-single" class="md-nav__link">
- llama_sample_repetition_penalty(SafeLLamaContextHandle, LLamaTokenDataArray, Memory<Int32>, UInt64, Single)
- </a>
-
- <nav class="md-nav" aria-label="llama_sample_repetition_penalty(SafeLLamaContextHandle, LLamaTokenDataArray, Memory<Int32>, UInt64, Single)">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#caution" class="md-nav__link">
- Caution
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#parameters_1" class="md-nav__link">
- Parameters
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#llama_sample_repetition_penaltysafellamacontexthandle-llamatokendataarray-memoryint32-single" class="md-nav__link">
- llama_sample_repetition_penalty(SafeLLamaContextHandle, LLamaTokenDataArray, Memory<Int32>, Single)
- </a>
-
- <nav class="md-nav" aria-label="llama_sample_repetition_penalty(SafeLLamaContextHandle, LLamaTokenDataArray, Memory<Int32>, Single)">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#parameters_2" class="md-nav__link">
- Parameters
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#llama_sample_frequency_and_presence_penaltiessafellamacontexthandle-llamatokendataarray-memoryint32-uint64-single-single" class="md-nav__link">
- llama_sample_frequency_and_presence_penalties(SafeLLamaContextHandle, LLamaTokenDataArray, Memory<Int32>, UInt64, Single, Single)
- </a>
-
- <nav class="md-nav" aria-label="llama_sample_frequency_and_presence_penalties(SafeLLamaContextHandle, LLamaTokenDataArray, Memory<Int32>, UInt64, Single, Single)">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#caution_1" class="md-nav__link">
- Caution
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#parameters_3" class="md-nav__link">
- Parameters
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#llama_sample_frequency_and_presence_penaltiessafellamacontexthandle-llamatokendataarray-memoryint32-single-single" class="md-nav__link">
- llama_sample_frequency_and_presence_penalties(SafeLLamaContextHandle, LLamaTokenDataArray, Memory<Int32>, Single, Single)
- </a>
-
- <nav class="md-nav" aria-label="llama_sample_frequency_and_presence_penalties(SafeLLamaContextHandle, LLamaTokenDataArray, Memory<Int32>, Single, Single)">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#parameters_4" class="md-nav__link">
- Parameters
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#llama_sample_softmaxsafellamacontexthandle-llamatokendataarray" class="md-nav__link">
- llama_sample_softmax(SafeLLamaContextHandle, LLamaTokenDataArray)
- </a>
-
- <nav class="md-nav" aria-label="llama_sample_softmax(SafeLLamaContextHandle, LLamaTokenDataArray)">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#parameters_5" class="md-nav__link">
- Parameters
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#llama_sample_top_ksafellamacontexthandle-llamatokendataarray-int32-uint64" class="md-nav__link">
- llama_sample_top_k(SafeLLamaContextHandle, LLamaTokenDataArray, Int32, UInt64)
- </a>
-
- <nav class="md-nav" aria-label="llama_sample_top_k(SafeLLamaContextHandle, LLamaTokenDataArray, Int32, UInt64)">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#parameters_6" class="md-nav__link">
- Parameters
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#llama_sample_top_psafellamacontexthandle-llamatokendataarray-single-uint64" class="md-nav__link">
- llama_sample_top_p(SafeLLamaContextHandle, LLamaTokenDataArray, Single, UInt64)
- </a>
-
- <nav class="md-nav" aria-label="llama_sample_top_p(SafeLLamaContextHandle, LLamaTokenDataArray, Single, UInt64)">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#parameters_7" class="md-nav__link">
- Parameters
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#llama_sample_tail_freesafellamacontexthandle-llamatokendataarray-single-uint64" class="md-nav__link">
- llama_sample_tail_free(SafeLLamaContextHandle, LLamaTokenDataArray, Single, UInt64)
- </a>
-
- <nav class="md-nav" aria-label="llama_sample_tail_free(SafeLLamaContextHandle, LLamaTokenDataArray, Single, UInt64)">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#parameters_8" class="md-nav__link">
- Parameters
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#llama_sample_typicalsafellamacontexthandle-llamatokendataarray-single-uint64" class="md-nav__link">
- llama_sample_typical(SafeLLamaContextHandle, LLamaTokenDataArray, Single, UInt64)
- </a>
-
- <nav class="md-nav" aria-label="llama_sample_typical(SafeLLamaContextHandle, LLamaTokenDataArray, Single, UInt64)">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#parameters_9" class="md-nav__link">
- Parameters
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#llama_sample_temperaturesafellamacontexthandle-llamatokendataarray-single" class="md-nav__link">
- llama_sample_temperature(SafeLLamaContextHandle, LLamaTokenDataArray, Single)
- </a>
-
- <nav class="md-nav" aria-label="llama_sample_temperature(SafeLLamaContextHandle, LLamaTokenDataArray, Single)">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#parameters_10" class="md-nav__link">
- Parameters
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#llama_sample_token_mirostatsafellamacontexthandle-llamatokendataarray-single-single-int32-single" class="md-nav__link">
- llama_sample_token_mirostat(SafeLLamaContextHandle, LLamaTokenDataArray, Single, Single, Int32, Single&)
- </a>
-
- <nav class="md-nav" aria-label="llama_sample_token_mirostat(SafeLLamaContextHandle, LLamaTokenDataArray, Single, Single, Int32, Single&)">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#parameters_11" class="md-nav__link">
- Parameters
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#returns" class="md-nav__link">
- Returns
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#llama_sample_token_mirostat_v2safellamacontexthandle-llamatokendataarray-single-single-single" class="md-nav__link">
- llama_sample_token_mirostat_v2(SafeLLamaContextHandle, LLamaTokenDataArray, Single, Single, Single&)
- </a>
-
- <nav class="md-nav" aria-label="llama_sample_token_mirostat_v2(SafeLLamaContextHandle, LLamaTokenDataArray, Single, Single, Single&)">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#parameters_12" class="md-nav__link">
- Parameters
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#returns_1" class="md-nav__link">
- Returns
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#llama_sample_token_greedysafellamacontexthandle-llamatokendataarray" class="md-nav__link">
- llama_sample_token_greedy(SafeLLamaContextHandle, LLamaTokenDataArray)
- </a>
-
- <nav class="md-nav" aria-label="llama_sample_token_greedy(SafeLLamaContextHandle, LLamaTokenDataArray)">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#parameters_13" class="md-nav__link">
- Parameters
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#returns_2" class="md-nav__link">
- Returns
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#llama_sample_tokensafellamacontexthandle-llamatokendataarray" class="md-nav__link">
- llama_sample_token(SafeLLamaContextHandle, LLamaTokenDataArray)
- </a>
-
- <nav class="md-nav" aria-label="llama_sample_token(SafeLLamaContextHandle, LLamaTokenDataArray)">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#parameters_14" class="md-nav__link">
- Parameters
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#returns_3" class="md-nav__link">
- Returns
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- </ul>
-
- </nav>
- </div>
- </div>
- </div>
-
-
-
- <div class="md-content" data-md-component="content">
- <article class="md-content__inner md-typeset">
-
-
-
-
- <h1 id="samplingapi">SamplingApi</h1>
- <p>Namespace: LLama.Native</p>
- <p>Direct translation of the llama.cpp sampling API</p>
- <pre><code class="language-csharp">public class SamplingApi
- </code></pre>
- <p>Inheritance <a href="https://docs.microsoft.com/en-us/dotnet/api/system.object">Object</a> → <a href="./">SamplingApi</a></p>
- <h2 id="constructors">Constructors</h2>
- <h3 id="samplingapi_1"><strong>SamplingApi()</strong></h3>
- <pre><code class="language-csharp">public SamplingApi()
- </code></pre>
- <h2 id="methods">Methods</h2>
- <h3 id="llama_sample_grammarsafellamacontexthandle-llamatokendataarray-safellamagrammarhandle"><strong>llama_sample_grammar(SafeLLamaContextHandle, LLamaTokenDataArray, SafeLLamaGrammarHandle)</strong></h3>
- <p>Apply grammar rules to candidate tokens</p>
- <pre><code class="language-csharp">public static void llama_sample_grammar(SafeLLamaContextHandle ctx, LLamaTokenDataArray candidates, SafeLLamaGrammarHandle grammar)
- </code></pre>
- <h4 id="parameters">Parameters</h4>
- <p><code>ctx</code> <a href="../llama.native.safellamacontexthandle/">SafeLLamaContextHandle</a><br></p>
- <p><code>candidates</code> <a href="../llama.native.llamatokendataarray/">LLamaTokenDataArray</a><br></p>
- <p><code>grammar</code> <a href="../llama.native.safellamagrammarhandle/">SafeLLamaGrammarHandle</a><br></p>
- <h3 id="llama_sample_repetition_penaltysafellamacontexthandle-llamatokendataarray-memoryint32-uint64-single"><strong>llama_sample_repetition_penalty(SafeLLamaContextHandle, LLamaTokenDataArray, Memory<Int32>, UInt64, Single)</strong></h3>
- <h4 id="caution">Caution</h4>
- <p>last_tokens_size parameter is no longer needed</p>
- <hr />
- <p>Repetition penalty described in CTRL academic paper https://arxiv.org/abs/1909.05858, with negative logit fix.</p>
- <pre><code class="language-csharp">public static void llama_sample_repetition_penalty(SafeLLamaContextHandle ctx, LLamaTokenDataArray candidates, Memory<int> last_tokens, ulong last_tokens_size, float penalty)
- </code></pre>
- <h4 id="parameters_1">Parameters</h4>
- <p><code>ctx</code> <a href="../llama.native.safellamacontexthandle/">SafeLLamaContextHandle</a><br></p>
- <p><code>candidates</code> <a href="../llama.native.llamatokendataarray/">LLamaTokenDataArray</a><br>
- Pointer to LLamaTokenDataArray</p>
- <p><code>last_tokens</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.memory-1">Memory<Int32></a><br></p>
- <p><code>last_tokens_size</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.uint64">UInt64</a><br></p>
- <p><code>penalty</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single">Single</a><br></p>
- <h3 id="llama_sample_repetition_penaltysafellamacontexthandle-llamatokendataarray-memoryint32-single"><strong>llama_sample_repetition_penalty(SafeLLamaContextHandle, LLamaTokenDataArray, Memory<Int32>, Single)</strong></h3>
- <p>Repetition penalty described in CTRL academic paper https://arxiv.org/abs/1909.05858, with negative logit fix.</p>
- <pre><code class="language-csharp">public static void llama_sample_repetition_penalty(SafeLLamaContextHandle ctx, LLamaTokenDataArray candidates, Memory<int> last_tokens, float penalty)
- </code></pre>
- <h4 id="parameters_2">Parameters</h4>
- <p><code>ctx</code> <a href="../llama.native.safellamacontexthandle/">SafeLLamaContextHandle</a><br></p>
- <p><code>candidates</code> <a href="../llama.native.llamatokendataarray/">LLamaTokenDataArray</a><br>
- Pointer to LLamaTokenDataArray</p>
- <p><code>last_tokens</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.memory-1">Memory<Int32></a><br></p>
- <p><code>penalty</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single">Single</a><br></p>
- <h3 id="llama_sample_frequency_and_presence_penaltiessafellamacontexthandle-llamatokendataarray-memoryint32-uint64-single-single"><strong>llama_sample_frequency_and_presence_penalties(SafeLLamaContextHandle, LLamaTokenDataArray, Memory<Int32>, UInt64, Single, Single)</strong></h3>
- <h4 id="caution_1">Caution</h4>
- <p>last_tokens_size parameter is no longer needed</p>
- <hr />
- <p>Frequency and presence penalties described in OpenAI API https://platform.openai.com/docs/api-reference/parameter-details.</p>
- <pre><code class="language-csharp">public static void llama_sample_frequency_and_presence_penalties(SafeLLamaContextHandle ctx, LLamaTokenDataArray candidates, Memory<int> last_tokens, ulong last_tokens_size, float alpha_frequency, float alpha_presence)
- </code></pre>
- <h4 id="parameters_3">Parameters</h4>
- <p><code>ctx</code> <a href="../llama.native.safellamacontexthandle/">SafeLLamaContextHandle</a><br></p>
- <p><code>candidates</code> <a href="../llama.native.llamatokendataarray/">LLamaTokenDataArray</a><br>
- Pointer to LLamaTokenDataArray</p>
- <p><code>last_tokens</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.memory-1">Memory<Int32></a><br></p>
- <p><code>last_tokens_size</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.uint64">UInt64</a><br></p>
- <p><code>alpha_frequency</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single">Single</a><br></p>
- <p><code>alpha_presence</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single">Single</a><br></p>
- <h3 id="llama_sample_frequency_and_presence_penaltiessafellamacontexthandle-llamatokendataarray-memoryint32-single-single"><strong>llama_sample_frequency_and_presence_penalties(SafeLLamaContextHandle, LLamaTokenDataArray, Memory<Int32>, Single, Single)</strong></h3>
- <p>Frequency and presence penalties described in OpenAI API https://platform.openai.com/docs/api-reference/parameter-details.</p>
- <pre><code class="language-csharp">public static void llama_sample_frequency_and_presence_penalties(SafeLLamaContextHandle ctx, LLamaTokenDataArray candidates, Memory<int> last_tokens, float alpha_frequency, float alpha_presence)
- </code></pre>
- <h4 id="parameters_4">Parameters</h4>
- <p><code>ctx</code> <a href="../llama.native.safellamacontexthandle/">SafeLLamaContextHandle</a><br></p>
- <p><code>candidates</code> <a href="../llama.native.llamatokendataarray/">LLamaTokenDataArray</a><br>
- Pointer to LLamaTokenDataArray</p>
- <p><code>last_tokens</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.memory-1">Memory<Int32></a><br></p>
- <p><code>alpha_frequency</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single">Single</a><br></p>
- <p><code>alpha_presence</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single">Single</a><br></p>
- <h3 id="llama_sample_softmaxsafellamacontexthandle-llamatokendataarray"><strong>llama_sample_softmax(SafeLLamaContextHandle, LLamaTokenDataArray)</strong></h3>
- <p>Sorts candidate tokens by their logits in descending order and calculate probabilities based on logits.</p>
- <pre><code class="language-csharp">public static void llama_sample_softmax(SafeLLamaContextHandle ctx, LLamaTokenDataArray candidates)
- </code></pre>
- <h4 id="parameters_5">Parameters</h4>
- <p><code>ctx</code> <a href="../llama.native.safellamacontexthandle/">SafeLLamaContextHandle</a><br></p>
- <p><code>candidates</code> <a href="../llama.native.llamatokendataarray/">LLamaTokenDataArray</a><br>
- Pointer to LLamaTokenDataArray</p>
- <h3 id="llama_sample_top_ksafellamacontexthandle-llamatokendataarray-int32-uint64"><strong>llama_sample_top_k(SafeLLamaContextHandle, LLamaTokenDataArray, Int32, UInt64)</strong></h3>
- <p>Top-K sampling described in academic paper "The Curious Case of Neural Text Degeneration" https://arxiv.org/abs/1904.09751</p>
- <pre><code class="language-csharp">public static void llama_sample_top_k(SafeLLamaContextHandle ctx, LLamaTokenDataArray candidates, int k, ulong min_keep)
- </code></pre>
- <h4 id="parameters_6">Parameters</h4>
- <p><code>ctx</code> <a href="../llama.native.safellamacontexthandle/">SafeLLamaContextHandle</a><br></p>
- <p><code>candidates</code> <a href="../llama.native.llamatokendataarray/">LLamaTokenDataArray</a><br>
- Pointer to LLamaTokenDataArray</p>
- <p><code>k</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.int32">Int32</a><br></p>
- <p><code>min_keep</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.uint64">UInt64</a><br></p>
- <h3 id="llama_sample_top_psafellamacontexthandle-llamatokendataarray-single-uint64"><strong>llama_sample_top_p(SafeLLamaContextHandle, LLamaTokenDataArray, Single, UInt64)</strong></h3>
- <p>Nucleus sampling described in academic paper "The Curious Case of Neural Text Degeneration" https://arxiv.org/abs/1904.09751</p>
- <pre><code class="language-csharp">public static void llama_sample_top_p(SafeLLamaContextHandle ctx, LLamaTokenDataArray candidates, float p, ulong min_keep)
- </code></pre>
- <h4 id="parameters_7">Parameters</h4>
- <p><code>ctx</code> <a href="../llama.native.safellamacontexthandle/">SafeLLamaContextHandle</a><br></p>
- <p><code>candidates</code> <a href="../llama.native.llamatokendataarray/">LLamaTokenDataArray</a><br>
- Pointer to LLamaTokenDataArray</p>
- <p><code>p</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single">Single</a><br></p>
- <p><code>min_keep</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.uint64">UInt64</a><br></p>
- <h3 id="llama_sample_tail_freesafellamacontexthandle-llamatokendataarray-single-uint64"><strong>llama_sample_tail_free(SafeLLamaContextHandle, LLamaTokenDataArray, Single, UInt64)</strong></h3>
- <p>Tail Free Sampling described in https://www.trentonbricken.com/Tail-Free-Sampling/.</p>
- <pre><code class="language-csharp">public static void llama_sample_tail_free(SafeLLamaContextHandle ctx, LLamaTokenDataArray candidates, float z, ulong min_keep)
- </code></pre>
- <h4 id="parameters_8">Parameters</h4>
- <p><code>ctx</code> <a href="../llama.native.safellamacontexthandle/">SafeLLamaContextHandle</a><br></p>
- <p><code>candidates</code> <a href="../llama.native.llamatokendataarray/">LLamaTokenDataArray</a><br>
- Pointer to LLamaTokenDataArray</p>
- <p><code>z</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single">Single</a><br></p>
- <p><code>min_keep</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.uint64">UInt64</a><br></p>
- <h3 id="llama_sample_typicalsafellamacontexthandle-llamatokendataarray-single-uint64"><strong>llama_sample_typical(SafeLLamaContextHandle, LLamaTokenDataArray, Single, UInt64)</strong></h3>
- <p>Locally Typical Sampling implementation described in the paper https://arxiv.org/abs/2202.00666.</p>
- <pre><code class="language-csharp">public static void llama_sample_typical(SafeLLamaContextHandle ctx, LLamaTokenDataArray candidates, float p, ulong min_keep)
- </code></pre>
- <h4 id="parameters_9">Parameters</h4>
- <p><code>ctx</code> <a href="../llama.native.safellamacontexthandle/">SafeLLamaContextHandle</a><br></p>
- <p><code>candidates</code> <a href="../llama.native.llamatokendataarray/">LLamaTokenDataArray</a><br>
- Pointer to LLamaTokenDataArray</p>
- <p><code>p</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single">Single</a><br></p>
- <p><code>min_keep</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.uint64">UInt64</a><br></p>
- <h3 id="llama_sample_temperaturesafellamacontexthandle-llamatokendataarray-single"><strong>llama_sample_temperature(SafeLLamaContextHandle, LLamaTokenDataArray, Single)</strong></h3>
- <p>Sample with temperature.
- As temperature increases, the prediction becomes diverse but also vulnerable to hallucinations -- generating tokens that are sensible but not factual</p>
- <pre><code class="language-csharp">public static void llama_sample_temperature(SafeLLamaContextHandle ctx, LLamaTokenDataArray candidates, float temp)
- </code></pre>
- <h4 id="parameters_10">Parameters</h4>
- <p><code>ctx</code> <a href="../llama.native.safellamacontexthandle/">SafeLLamaContextHandle</a><br></p>
- <p><code>candidates</code> <a href="../llama.native.llamatokendataarray/">LLamaTokenDataArray</a><br></p>
- <p><code>temp</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single">Single</a><br></p>
- <h3 id="llama_sample_token_mirostatsafellamacontexthandle-llamatokendataarray-single-single-int32-single"><strong>llama_sample_token_mirostat(SafeLLamaContextHandle, LLamaTokenDataArray, Single, Single, Int32, Single&)</strong></h3>
- <p>Mirostat 1.0 algorithm described in the paper https://arxiv.org/abs/2007.14966. Uses tokens instead of words.</p>
- <pre><code class="language-csharp">public static int llama_sample_token_mirostat(SafeLLamaContextHandle ctx, LLamaTokenDataArray candidates, float tau, float eta, int m, Single& mu)
- </code></pre>
- <h4 id="parameters_11">Parameters</h4>
- <p><code>ctx</code> <a href="../llama.native.safellamacontexthandle/">SafeLLamaContextHandle</a><br></p>
- <p><code>candidates</code> <a href="../llama.native.llamatokendataarray/">LLamaTokenDataArray</a><br>
- A vector of <code>LLamaTokenData</code> containing the candidate tokens, their probabilities (p), and log-odds (logit) for the current position in the generated text.</p>
- <p><code>tau</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single">Single</a><br>
- The target cross-entropy (or surprise) value you want to achieve for the generated text. A higher value corresponds to more surprising or less predictable text, while a lower value corresponds to less surprising or more predictable text.</p>
- <p><code>eta</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single">Single</a><br>
- The learning rate used to update <code>mu</code> based on the error between the target and observed surprisal of the sampled word. A larger learning rate will cause <code>mu</code> to be updated more quickly, while a smaller learning rate will result in slower updates.</p>
- <p><code>m</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.int32">Int32</a><br>
- The number of tokens considered in the estimation of <code>s_hat</code>. This is an arbitrary value that is used to calculate <code>s_hat</code>, which in turn helps to calculate the value of <code>k</code>. In the paper, they use <code>m = 100</code>, but you can experiment with different values to see how it affects the performance of the algorithm.</p>
- <p><code>mu</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single&">Single&</a><br>
- Maximum cross-entropy. This value is initialized to be twice the target cross-entropy (<code>2 * tau</code>) and is updated in the algorithm based on the error between the target and observed surprisal.</p>
- <h4 id="returns">Returns</h4>
- <p><a href="https://docs.microsoft.com/en-us/dotnet/api/system.int32">Int32</a><br></p>
- <h3 id="llama_sample_token_mirostat_v2safellamacontexthandle-llamatokendataarray-single-single-single"><strong>llama_sample_token_mirostat_v2(SafeLLamaContextHandle, LLamaTokenDataArray, Single, Single, Single&)</strong></h3>
- <p>Mirostat 2.0 algorithm described in the paper https://arxiv.org/abs/2007.14966. Uses tokens instead of words.</p>
- <pre><code class="language-csharp">public static int llama_sample_token_mirostat_v2(SafeLLamaContextHandle ctx, LLamaTokenDataArray candidates, float tau, float eta, Single& mu)
- </code></pre>
- <h4 id="parameters_12">Parameters</h4>
- <p><code>ctx</code> <a href="../llama.native.safellamacontexthandle/">SafeLLamaContextHandle</a><br></p>
- <p><code>candidates</code> <a href="../llama.native.llamatokendataarray/">LLamaTokenDataArray</a><br>
- A vector of <code>LLamaTokenData</code> containing the candidate tokens, their probabilities (p), and log-odds (logit) for the current position in the generated text.</p>
- <p><code>tau</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single">Single</a><br>
- The target cross-entropy (or surprise) value you want to achieve for the generated text. A higher value corresponds to more surprising or less predictable text, while a lower value corresponds to less surprising or more predictable text.</p>
- <p><code>eta</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single">Single</a><br>
- The learning rate used to update <code>mu</code> based on the error between the target and observed surprisal of the sampled word. A larger learning rate will cause <code>mu</code> to be updated more quickly, while a smaller learning rate will result in slower updates.</p>
- <p><code>mu</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single&">Single&</a><br>
- Maximum cross-entropy. This value is initialized to be twice the target cross-entropy (<code>2 * tau</code>) and is updated in the algorithm based on the error between the target and observed surprisal.</p>
- <h4 id="returns_1">Returns</h4>
- <p><a href="https://docs.microsoft.com/en-us/dotnet/api/system.int32">Int32</a><br></p>
- <h3 id="llama_sample_token_greedysafellamacontexthandle-llamatokendataarray"><strong>llama_sample_token_greedy(SafeLLamaContextHandle, LLamaTokenDataArray)</strong></h3>
- <p>Selects the token with the highest probability.</p>
- <pre><code class="language-csharp">public static int llama_sample_token_greedy(SafeLLamaContextHandle ctx, LLamaTokenDataArray candidates)
- </code></pre>
- <h4 id="parameters_13">Parameters</h4>
- <p><code>ctx</code> <a href="../llama.native.safellamacontexthandle/">SafeLLamaContextHandle</a><br></p>
- <p><code>candidates</code> <a href="../llama.native.llamatokendataarray/">LLamaTokenDataArray</a><br>
- Pointer to LLamaTokenDataArray</p>
- <h4 id="returns_2">Returns</h4>
- <p><a href="https://docs.microsoft.com/en-us/dotnet/api/system.int32">Int32</a><br></p>
- <h3 id="llama_sample_tokensafellamacontexthandle-llamatokendataarray"><strong>llama_sample_token(SafeLLamaContextHandle, LLamaTokenDataArray)</strong></h3>
- <p>Randomly selects a token from the candidates based on their probabilities.</p>
- <pre><code class="language-csharp">public static int llama_sample_token(SafeLLamaContextHandle ctx, LLamaTokenDataArray candidates)
- </code></pre>
- <h4 id="parameters_14">Parameters</h4>
- <p><code>ctx</code> <a href="../llama.native.safellamacontexthandle/">SafeLLamaContextHandle</a><br></p>
- <p><code>candidates</code> <a href="../llama.native.llamatokendataarray/">LLamaTokenDataArray</a><br>
- Pointer to LLamaTokenDataArray</p>
- <h4 id="returns_3">Returns</h4>
- <p><a href="https://docs.microsoft.com/en-us/dotnet/api/system.int32">Int32</a><br></p>
-
-
-
-
-
-
- </article>
- </div>
-
-
- </div>
-
- </main>
-
- <footer class="md-footer">
-
- <div class="md-footer-meta md-typeset">
- <div class="md-footer-meta__inner md-grid">
- <div class="md-copyright">
-
-
- Made with
- <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
- Material for MkDocs
- </a>
-
- </div>
-
- </div>
- </div>
- </footer>
-
- </div>
- <div class="md-dialog" data-md-component="dialog">
- <div class="md-dialog__inner md-typeset"></div>
- </div>
-
- <script id="__config" type="application/json">{"base": "../..", "features": [], "search": "../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
-
-
- <script src="../../assets/javascripts/bundle.a51614de.min.js"></script>
-
-
- </body>
- </html>
|