You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

index.html 78 kB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001
  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <link rel="prev" href="../llama.native.safellamamodelhandle/">
  7. <link rel="next" href="../llama.oldversion.chatcompletion/">
  8. <link rel="icon" href="../../assets/images/favicon.png">
  9. <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.16">
  10. <title>llama.native.samplingapi - LLamaSharp Documentation</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.26e3688c.min.css">
  12. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  13. <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">
  14. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  15. <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>
  16. </head>
  17. <body dir="ltr">
  18. <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>
  19. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  20. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  21. <label class="md-overlay" for="__drawer"></label>
  22. <div data-md-component="skip">
  23. <a href="#samplingapi" class="md-skip">
  24. Skip to content
  25. </a>
  26. </div>
  27. <div data-md-component="announce">
  28. </div>
  29. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  30. </div>
  31. <header class="md-header md-header--shadow" data-md-component="header">
  32. <nav class="md-header__inner md-grid" aria-label="Header">
  33. <a href="../.." title="LLamaSharp Documentation" class="md-header__button md-logo" aria-label="LLamaSharp Documentation" data-md-component="logo">
  34. <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>
  35. </a>
  36. <label class="md-header__button md-icon" for="__drawer">
  37. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
  38. </label>
  39. <div class="md-header__title" data-md-component="header-title">
  40. <div class="md-header__ellipsis">
  41. <div class="md-header__topic">
  42. <span class="md-ellipsis">
  43. LLamaSharp Documentation
  44. </span>
  45. </div>
  46. <div class="md-header__topic" data-md-component="header-topic">
  47. <span class="md-ellipsis">
  48. llama.native.samplingapi
  49. </span>
  50. </div>
  51. </div>
  52. </div>
  53. <label class="md-header__button md-icon" for="__search">
  54. <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>
  55. </label>
  56. <div class="md-search" data-md-component="search" role="dialog">
  57. <label class="md-search__overlay" for="__search"></label>
  58. <div class="md-search__inner" role="search">
  59. <form class="md-search__form" name="search">
  60. <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>
  61. <label class="md-search__icon md-icon" for="__search">
  62. <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>
  63. <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>
  64. </label>
  65. <nav class="md-search__options" aria-label="Search">
  66. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  67. <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>
  68. </button>
  69. </nav>
  70. </form>
  71. <div class="md-search__output">
  72. <div class="md-search__scrollwrap" data-md-scrollfix>
  73. <div class="md-search-result" data-md-component="search-result">
  74. <div class="md-search-result__meta">
  75. Initializing search
  76. </div>
  77. <ol class="md-search-result__list" role="presentation"></ol>
  78. </div>
  79. </div>
  80. </div>
  81. </div>
  82. </div>
  83. </nav>
  84. </header>
  85. <div class="md-container" data-md-component="container">
  86. <main class="md-main" data-md-component="main">
  87. <div class="md-main__inner md-grid">
  88. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  89. <div class="md-sidebar__scrollwrap">
  90. <div class="md-sidebar__inner">
  91. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  92. <label class="md-nav__title" for="__drawer">
  93. <a href="../.." title="LLamaSharp Documentation" class="md-nav__button md-logo" aria-label="LLamaSharp Documentation" data-md-component="logo">
  94. <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>
  95. </a>
  96. LLamaSharp Documentation
  97. </label>
  98. <ul class="md-nav__list" data-md-scrollfix>
  99. <li class="md-nav__item">
  100. <a href="../.." class="md-nav__link">
  101. Overview
  102. </a>
  103. </li>
  104. <li class="md-nav__item">
  105. <a href="../../GetStarted/" class="md-nav__link">
  106. Get Started
  107. </a>
  108. </li>
  109. <li class="md-nav__item">
  110. <a href="../../Architecture/" class="md-nav__link">
  111. Architecture
  112. </a>
  113. </li>
  114. <li class="md-nav__item">
  115. <a href="../../Tricks/" class="md-nav__link">
  116. Tricks for FAQ
  117. </a>
  118. </li>
  119. <li class="md-nav__item">
  120. <a href="../../ContributingGuide/" class="md-nav__link">
  121. Contributing Guide
  122. </a>
  123. </li>
  124. <li class="md-nav__item md-nav__item--nested">
  125. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
  126. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  127. LLamaContext
  128. <span class="md-nav__icon md-icon"></span>
  129. </label>
  130. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  131. <label class="md-nav__title" for="__nav_6">
  132. <span class="md-nav__icon md-icon"></span>
  133. LLamaContext
  134. </label>
  135. <ul class="md-nav__list" data-md-scrollfix>
  136. <li class="md-nav__item">
  137. <a href="../../LLamaContext/parameters.md" class="md-nav__link">
  138. Context Parameters
  139. </a>
  140. </li>
  141. <li class="md-nav__item">
  142. <a href="../../LLamaContext/tokenization.md" class="md-nav__link">
  143. Tokenization
  144. </a>
  145. </li>
  146. <li class="md-nav__item">
  147. <a href="../../LLamaContext/embeddings.md" class="md-nav__link">
  148. Get Embeddings
  149. </a>
  150. </li>
  151. <li class="md-nav__item">
  152. <a href="../../LLamaContext/quantization.md" class="md-nav__link">
  153. Quantization
  154. </a>
  155. </li>
  156. <li class="md-nav__item">
  157. <a href="../../LLamaContext/save-load-state.md" class="md-nav__link">
  158. Save/Load State
  159. </a>
  160. </li>
  161. </ul>
  162. </nav>
  163. </li>
  164. <li class="md-nav__item md-nav__item--nested">
  165. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
  166. <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
  167. LLamaExecutors
  168. <span class="md-nav__icon md-icon"></span>
  169. </label>
  170. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
  171. <label class="md-nav__title" for="__nav_7">
  172. <span class="md-nav__icon md-icon"></span>
  173. LLamaExecutors
  174. </label>
  175. <ul class="md-nav__list" data-md-scrollfix>
  176. <li class="md-nav__item">
  177. <a href="../../LLamaExecutors/parameters/" class="md-nav__link">
  178. Inference Parameters
  179. </a>
  180. </li>
  181. <li class="md-nav__item">
  182. <a href="../../LLamaExecutors/text-to-text-apis/" class="md-nav__link">
  183. Text-to-Text APIs
  184. </a>
  185. </li>
  186. <li class="md-nav__item">
  187. <a href="../../LLamaExecutors/save-load-state/" class="md-nav__link">
  188. Save/Load State
  189. </a>
  190. </li>
  191. <li class="md-nav__item">
  192. <a href="../../LLamaExecutors/differences/" class="md-nav__link">
  193. Differences of Executors
  194. </a>
  195. </li>
  196. </ul>
  197. </nav>
  198. </li>
  199. <li class="md-nav__item md-nav__item--nested">
  200. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" >
  201. <label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
  202. ChatSession
  203. <span class="md-nav__icon md-icon"></span>
  204. </label>
  205. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
  206. <label class="md-nav__title" for="__nav_8">
  207. <span class="md-nav__icon md-icon"></span>
  208. ChatSession
  209. </label>
  210. <ul class="md-nav__list" data-md-scrollfix>
  211. <li class="md-nav__item">
  212. <a href="../../ChatSession/basic-usages/" class="md-nav__link">
  213. Basic Usages
  214. </a>
  215. </li>
  216. <li class="md-nav__item">
  217. <a href="../../ChatSession/transforms/" class="md-nav__link">
  218. Transoforms
  219. </a>
  220. </li>
  221. <li class="md-nav__item">
  222. <a href="../../ChatSession/save-load-session/" class="md-nav__link">
  223. Save/Load Session
  224. </a>
  225. </li>
  226. </ul>
  227. </nav>
  228. </li>
  229. <li class="md-nav__item md-nav__item--nested">
  230. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9" >
  231. <label class="md-nav__link" for="__nav_9" id="__nav_9_label" tabindex="0">
  232. Non-English Usages
  233. <span class="md-nav__icon md-icon"></span>
  234. </label>
  235. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
  236. <label class="md-nav__title" for="__nav_9">
  237. <span class="md-nav__icon md-icon"></span>
  238. Non-English Usages
  239. </label>
  240. <ul class="md-nav__list" data-md-scrollfix>
  241. <li class="md-nav__item">
  242. <a href="../../NonEnglishUsage/Chinese/" class="md-nav__link">
  243. Chinese
  244. </a>
  245. </li>
  246. </ul>
  247. </nav>
  248. </li>
  249. <li class="md-nav__item md-nav__item--nested">
  250. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10" >
  251. <label class="md-nav__link" for="__nav_10" id="__nav_10_label" tabindex="0">
  252. High-level Applications
  253. <span class="md-nav__icon md-icon"></span>
  254. </label>
  255. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
  256. <label class="md-nav__title" for="__nav_10">
  257. <span class="md-nav__icon md-icon"></span>
  258. High-level Applications
  259. </label>
  260. <ul class="md-nav__list" data-md-scrollfix>
  261. <li class="md-nav__item">
  262. <a href="../../HighLevelApps/bot-sharp/" class="md-nav__link">
  263. BotSharp
  264. </a>
  265. </li>
  266. <li class="md-nav__item">
  267. <a href="../../HighLevelApps/semantic-kernel/" class="md-nav__link">
  268. semantic-kernel
  269. </a>
  270. </li>
  271. </ul>
  272. </nav>
  273. </li>
  274. <li class="md-nav__item md-nav__item--nested">
  275. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_11" >
  276. <label class="md-nav__link" for="__nav_11" id="__nav_11_label" tabindex="0">
  277. More
  278. <span class="md-nav__icon md-icon"></span>
  279. </label>
  280. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
  281. <label class="md-nav__title" for="__nav_11">
  282. <span class="md-nav__icon md-icon"></span>
  283. More
  284. </label>
  285. <ul class="md-nav__list" data-md-scrollfix>
  286. <li class="md-nav__item">
  287. <a href="../../More/log/" class="md-nav__link">
  288. Logger
  289. </a>
  290. </li>
  291. </ul>
  292. </nav>
  293. </li>
  294. <li class="md-nav__item md-nav__item--nested">
  295. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_12" >
  296. <label class="md-nav__link" for="__nav_12" id="__nav_12_label" tabindex="0">
  297. Examples
  298. <span class="md-nav__icon md-icon"></span>
  299. </label>
  300. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_12_label" aria-expanded="false">
  301. <label class="md-nav__title" for="__nav_12">
  302. <span class="md-nav__icon md-icon"></span>
  303. Examples
  304. </label>
  305. <ul class="md-nav__list" data-md-scrollfix>
  306. <li class="md-nav__item">
  307. <a href="../../Examples/ChatSessionStripRoleName/" class="md-nav__link">
  308. Chat session 1
  309. </a>
  310. </li>
  311. <li class="md-nav__item">
  312. <a href="../../Examples/ChatSessionWithRoleName/" class="md-nav__link">
  313. Chat session 2
  314. </a>
  315. </li>
  316. <li class="md-nav__item">
  317. <a href="../../Examples/GetEmbeddings/" class="md-nav__link">
  318. Get embeddings
  319. </a>
  320. </li>
  321. <li class="md-nav__item">
  322. <a href="../../Examples/InstructModeExecute/" class="md-nav__link">
  323. Instruct executor
  324. </a>
  325. </li>
  326. <li class="md-nav__item">
  327. <a href="../../Examples/InteractiveModeExecute/" class="md-nav__link">
  328. Interactive executor
  329. </a>
  330. </li>
  331. <li class="md-nav__item">
  332. <a href="../../Examples/StatelessModeExecute/" class="md-nav__link">
  333. Stateless exeutor
  334. </a>
  335. </li>
  336. <li class="md-nav__item">
  337. <a href="../../Examples/LoadAndSaveSession/" class="md-nav__link">
  338. Load/Save session
  339. </a>
  340. </li>
  341. <li class="md-nav__item">
  342. <a href="../../Examples/LoadAndSaveState/" class="md-nav__link">
  343. Load/Save state
  344. </a>
  345. </li>
  346. <li class="md-nav__item">
  347. <a href="../../Examples/QuantizeModel/" class="md-nav__link">
  348. Quantize model
  349. </a>
  350. </li>
  351. </ul>
  352. </nav>
  353. </li>
  354. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  355. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_13" checked>
  356. <label class="md-nav__link" for="__nav_13" id="__nav_13_label" tabindex="0">
  357. API Reference
  358. <span class="md-nav__icon md-icon"></span>
  359. </label>
  360. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_13_label" aria-expanded="true">
  361. <label class="md-nav__title" for="__nav_13">
  362. <span class="md-nav__icon md-icon"></span>
  363. API Reference
  364. </label>
  365. <ul class="md-nav__list" data-md-scrollfix>
  366. <li class="md-nav__item">
  367. <a href="../" class="md-nav__link">
  368. index
  369. </a>
  370. </li>
  371. <li class="md-nav__item">
  372. <a href="../llama.abstractions.ihistorytransform/" class="md-nav__link">
  373. llama.abstractions.ihistorytransform
  374. </a>
  375. </li>
  376. <li class="md-nav__item">
  377. <a href="../llama.abstractions.iinferenceparams/" class="md-nav__link">
  378. llama.abstractions.iinferenceparams
  379. </a>
  380. </li>
  381. <li class="md-nav__item">
  382. <a href="../llama.abstractions.illamaexecutor/" class="md-nav__link">
  383. llama.abstractions.illamaexecutor
  384. </a>
  385. </li>
  386. <li class="md-nav__item">
  387. <a href="../llama.abstractions.imodelparams/" class="md-nav__link">
  388. llama.abstractions.imodelparams
  389. </a>
  390. </li>
  391. <li class="md-nav__item">
  392. <a href="../llama.abstractions.itextstreamtransform/" class="md-nav__link">
  393. llama.abstractions.itextstreamtransform
  394. </a>
  395. </li>
  396. <li class="md-nav__item">
  397. <a href="../llama.abstractions.itexttransform/" class="md-nav__link">
  398. llama.abstractions.itexttransform
  399. </a>
  400. </li>
  401. <li class="md-nav__item">
  402. <a href="../llama.chatsession/" class="md-nav__link">
  403. llama.chatsession
  404. </a>
  405. </li>
  406. <li class="md-nav__item">
  407. <a href="../llama.common.authorrole/" class="md-nav__link">
  408. llama.common.authorrole
  409. </a>
  410. </li>
  411. <li class="md-nav__item">
  412. <a href="../llama.common.chathistory/" class="md-nav__link">
  413. llama.common.chathistory
  414. </a>
  415. </li>
  416. <li class="md-nav__item">
  417. <a href="../llama.common.fixedsizequeue-1/" class="md-nav__link">
  418. llama.common.fixedsizequeue-1
  419. </a>
  420. </li>
  421. <li class="md-nav__item">
  422. <a href="../llama.common.illamalogger/" class="md-nav__link">
  423. llama.common.illamalogger
  424. </a>
  425. </li>
  426. <li class="md-nav__item">
  427. <a href="../llama.common.inferenceparams/" class="md-nav__link">
  428. llama.common.inferenceparams
  429. </a>
  430. </li>
  431. <li class="md-nav__item">
  432. <a href="../llama.common.llamadefaultlogger/" class="md-nav__link">
  433. llama.common.llamadefaultlogger
  434. </a>
  435. </li>
  436. <li class="md-nav__item">
  437. <a href="../llama.common.mirostattype/" class="md-nav__link">
  438. llama.common.mirostattype
  439. </a>
  440. </li>
  441. <li class="md-nav__item">
  442. <a href="../llama.common.modelparams/" class="md-nav__link">
  443. llama.common.modelparams
  444. </a>
  445. </li>
  446. <li class="md-nav__item">
  447. <a href="../llama.exceptions.grammarexpectedname/" class="md-nav__link">
  448. llama.exceptions.grammarexpectedname
  449. </a>
  450. </li>
  451. <li class="md-nav__item">
  452. <a href="../llama.exceptions.grammarexpectednext/" class="md-nav__link">
  453. llama.exceptions.grammarexpectednext
  454. </a>
  455. </li>
  456. <li class="md-nav__item">
  457. <a href="../llama.exceptions.grammarexpectedprevious/" class="md-nav__link">
  458. llama.exceptions.grammarexpectedprevious
  459. </a>
  460. </li>
  461. <li class="md-nav__item">
  462. <a href="../llama.exceptions.grammarformatexception/" class="md-nav__link">
  463. llama.exceptions.grammarformatexception
  464. </a>
  465. </li>
  466. <li class="md-nav__item">
  467. <a href="../llama.exceptions.grammarunexpectedcharaltelement/" class="md-nav__link">
  468. llama.exceptions.grammarunexpectedcharaltelement
  469. </a>
  470. </li>
  471. <li class="md-nav__item">
  472. <a href="../llama.exceptions.grammarunexpectedcharrngelement/" class="md-nav__link">
  473. llama.exceptions.grammarunexpectedcharrngelement
  474. </a>
  475. </li>
  476. <li class="md-nav__item">
  477. <a href="../llama.exceptions.grammarunexpectedendelement/" class="md-nav__link">
  478. llama.exceptions.grammarunexpectedendelement
  479. </a>
  480. </li>
  481. <li class="md-nav__item">
  482. <a href="../llama.exceptions.grammarunexpectedendofinput/" class="md-nav__link">
  483. llama.exceptions.grammarunexpectedendofinput
  484. </a>
  485. </li>
  486. <li class="md-nav__item">
  487. <a href="../llama.exceptions.grammarunexpectedhexcharscount/" class="md-nav__link">
  488. llama.exceptions.grammarunexpectedhexcharscount
  489. </a>
  490. </li>
  491. <li class="md-nav__item">
  492. <a href="../llama.exceptions.grammarunknownescapecharacter/" class="md-nav__link">
  493. llama.exceptions.grammarunknownescapecharacter
  494. </a>
  495. </li>
  496. <li class="md-nav__item">
  497. <a href="../llama.exceptions.runtimeerror/" class="md-nav__link">
  498. llama.exceptions.runtimeerror
  499. </a>
  500. </li>
  501. <li class="md-nav__item">
  502. <a href="../llama.extensions.imodelparamsextensions/" class="md-nav__link">
  503. llama.extensions.imodelparamsextensions
  504. </a>
  505. </li>
  506. <li class="md-nav__item">
  507. <a href="../llama.extensions.keyvaluepairextensions/" class="md-nav__link">
  508. llama.extensions.keyvaluepairextensions
  509. </a>
  510. </li>
  511. <li class="md-nav__item">
  512. <a href="../llama.grammars.grammar/" class="md-nav__link">
  513. llama.grammars.grammar
  514. </a>
  515. </li>
  516. <li class="md-nav__item">
  517. <a href="../llama.grammars.grammarrule/" class="md-nav__link">
  518. llama.grammars.grammarrule
  519. </a>
  520. </li>
  521. <li class="md-nav__item">
  522. <a href="../llama.instructexecutor/" class="md-nav__link">
  523. llama.instructexecutor
  524. </a>
  525. </li>
  526. <li class="md-nav__item">
  527. <a href="../llama.interactiveexecutor/" class="md-nav__link">
  528. llama.interactiveexecutor
  529. </a>
  530. </li>
  531. <li class="md-nav__item">
  532. <a href="../llama.llamacontext/" class="md-nav__link">
  533. llama.llamacontext
  534. </a>
  535. </li>
  536. <li class="md-nav__item">
  537. <a href="../llama.llamaembedder/" class="md-nav__link">
  538. llama.llamaembedder
  539. </a>
  540. </li>
  541. <li class="md-nav__item">
  542. <a href="../llama.llamaquantizer/" class="md-nav__link">
  543. llama.llamaquantizer
  544. </a>
  545. </li>
  546. <li class="md-nav__item">
  547. <a href="../llama.llamatransforms/" class="md-nav__link">
  548. llama.llamatransforms
  549. </a>
  550. </li>
  551. <li class="md-nav__item">
  552. <a href="../llama.llamaweights/" class="md-nav__link">
  553. llama.llamaweights
  554. </a>
  555. </li>
  556. <li class="md-nav__item">
  557. <a href="../llama.native.llamacontextparams/" class="md-nav__link">
  558. llama.native.llamacontextparams
  559. </a>
  560. </li>
  561. <li class="md-nav__item">
  562. <a href="../llama.native.llamaftype/" class="md-nav__link">
  563. llama.native.llamaftype
  564. </a>
  565. </li>
  566. <li class="md-nav__item">
  567. <a href="../llama.native.llamagrammarelement/" class="md-nav__link">
  568. llama.native.llamagrammarelement
  569. </a>
  570. </li>
  571. <li class="md-nav__item">
  572. <a href="../llama.native.llamagrammarelementtype/" class="md-nav__link">
  573. llama.native.llamagrammarelementtype
  574. </a>
  575. </li>
  576. <li class="md-nav__item">
  577. <a href="../llama.native.llamamodelquantizeparams/" class="md-nav__link">
  578. llama.native.llamamodelquantizeparams
  579. </a>
  580. </li>
  581. <li class="md-nav__item">
  582. <a href="../llama.native.llamatokendata/" class="md-nav__link">
  583. llama.native.llamatokendata
  584. </a>
  585. </li>
  586. <li class="md-nav__item">
  587. <a href="../llama.native.llamatokendataarray/" class="md-nav__link">
  588. llama.native.llamatokendataarray
  589. </a>
  590. </li>
  591. <li class="md-nav__item">
  592. <a href="../llama.native.llamatokendataarraynative/" class="md-nav__link">
  593. llama.native.llamatokendataarraynative
  594. </a>
  595. </li>
  596. <li class="md-nav__item">
  597. <a href="../llama.native.nativeapi/" class="md-nav__link">
  598. llama.native.nativeapi
  599. </a>
  600. </li>
  601. <li class="md-nav__item">
  602. <a href="../llama.native.safellamacontexthandle/" class="md-nav__link">
  603. llama.native.safellamacontexthandle
  604. </a>
  605. </li>
  606. <li class="md-nav__item">
  607. <a href="../llama.native.safellamagrammarhandle/" class="md-nav__link">
  608. llama.native.safellamagrammarhandle
  609. </a>
  610. </li>
  611. <li class="md-nav__item">
  612. <a href="../llama.native.safellamahandlebase/" class="md-nav__link">
  613. llama.native.safellamahandlebase
  614. </a>
  615. </li>
  616. <li class="md-nav__item">
  617. <a href="../llama.native.safellamamodelhandle/" class="md-nav__link">
  618. llama.native.safellamamodelhandle
  619. </a>
  620. </li>
  621. <li class="md-nav__item md-nav__item--active">
  622. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  623. <label class="md-nav__link md-nav__link--active" for="__toc">
  624. llama.native.samplingapi
  625. <span class="md-nav__icon md-icon"></span>
  626. </label>
  627. <a href="./" class="md-nav__link md-nav__link--active">
  628. llama.native.samplingapi
  629. </a>
  630. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  631. <label class="md-nav__title" for="__toc">
  632. <span class="md-nav__icon md-icon"></span>
  633. Table of contents
  634. </label>
  635. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  636. <li class="md-nav__item">
  637. <a href="#constructors" class="md-nav__link">
  638. Constructors
  639. </a>
  640. <nav class="md-nav" aria-label="Constructors">
  641. <ul class="md-nav__list">
  642. <li class="md-nav__item">
  643. <a href="#samplingapi_1" class="md-nav__link">
  644. SamplingApi()
  645. </a>
  646. </li>
  647. </ul>
  648. </nav>
  649. </li>
  650. <li class="md-nav__item">
  651. <a href="#methods" class="md-nav__link">
  652. Methods
  653. </a>
  654. <nav class="md-nav" aria-label="Methods">
  655. <ul class="md-nav__list">
  656. <li class="md-nav__item">
  657. <a href="#llama_sample_grammarsafellamacontexthandle-llamatokendataarray-safellamagrammarhandle" class="md-nav__link">
  658. llama_sample_grammar(SafeLLamaContextHandle, LLamaTokenDataArray, SafeLLamaGrammarHandle)
  659. </a>
  660. <nav class="md-nav" aria-label="llama_sample_grammar(SafeLLamaContextHandle, LLamaTokenDataArray, SafeLLamaGrammarHandle)">
  661. <ul class="md-nav__list">
  662. <li class="md-nav__item">
  663. <a href="#parameters" class="md-nav__link">
  664. Parameters
  665. </a>
  666. </li>
  667. </ul>
  668. </nav>
  669. </li>
  670. <li class="md-nav__item">
  671. <a href="#llama_sample_repetition_penaltysafellamacontexthandle-llamatokendataarray-memoryint32-uint64-single" class="md-nav__link">
  672. llama_sample_repetition_penalty(SafeLLamaContextHandle, LLamaTokenDataArray, Memory&lt;Int32&gt;, UInt64, Single)
  673. </a>
  674. <nav class="md-nav" aria-label="llama_sample_repetition_penalty(SafeLLamaContextHandle, LLamaTokenDataArray, Memory<Int32>, UInt64, Single)">
  675. <ul class="md-nav__list">
  676. <li class="md-nav__item">
  677. <a href="#caution" class="md-nav__link">
  678. Caution
  679. </a>
  680. </li>
  681. <li class="md-nav__item">
  682. <a href="#parameters_1" class="md-nav__link">
  683. Parameters
  684. </a>
  685. </li>
  686. </ul>
  687. </nav>
  688. </li>
  689. <li class="md-nav__item">
  690. <a href="#llama_sample_repetition_penaltysafellamacontexthandle-llamatokendataarray-memoryint32-single" class="md-nav__link">
  691. llama_sample_repetition_penalty(SafeLLamaContextHandle, LLamaTokenDataArray, Memory&lt;Int32&gt;, Single)
  692. </a>
  693. <nav class="md-nav" aria-label="llama_sample_repetition_penalty(SafeLLamaContextHandle, LLamaTokenDataArray, Memory<Int32>, Single)">
  694. <ul class="md-nav__list">
  695. <li class="md-nav__item">
  696. <a href="#parameters_2" class="md-nav__link">
  697. Parameters
  698. </a>
  699. </li>
  700. </ul>
  701. </nav>
  702. </li>
  703. <li class="md-nav__item">
  704. <a href="#llama_sample_frequency_and_presence_penaltiessafellamacontexthandle-llamatokendataarray-memoryint32-uint64-single-single" class="md-nav__link">
  705. llama_sample_frequency_and_presence_penalties(SafeLLamaContextHandle, LLamaTokenDataArray, Memory&lt;Int32&gt;, UInt64, Single, Single)
  706. </a>
  707. <nav class="md-nav" aria-label="llama_sample_frequency_and_presence_penalties(SafeLLamaContextHandle, LLamaTokenDataArray, Memory<Int32>, UInt64, Single, Single)">
  708. <ul class="md-nav__list">
  709. <li class="md-nav__item">
  710. <a href="#caution_1" class="md-nav__link">
  711. Caution
  712. </a>
  713. </li>
  714. <li class="md-nav__item">
  715. <a href="#parameters_3" class="md-nav__link">
  716. Parameters
  717. </a>
  718. </li>
  719. </ul>
  720. </nav>
  721. </li>
  722. <li class="md-nav__item">
  723. <a href="#llama_sample_frequency_and_presence_penaltiessafellamacontexthandle-llamatokendataarray-memoryint32-single-single" class="md-nav__link">
  724. llama_sample_frequency_and_presence_penalties(SafeLLamaContextHandle, LLamaTokenDataArray, Memory&lt;Int32&gt;, Single, Single)
  725. </a>
  726. <nav class="md-nav" aria-label="llama_sample_frequency_and_presence_penalties(SafeLLamaContextHandle, LLamaTokenDataArray, Memory<Int32>, Single, Single)">
  727. <ul class="md-nav__list">
  728. <li class="md-nav__item">
  729. <a href="#parameters_4" class="md-nav__link">
  730. Parameters
  731. </a>
  732. </li>
  733. </ul>
  734. </nav>
  735. </li>
  736. <li class="md-nav__item">
  737. <a href="#llama_sample_softmaxsafellamacontexthandle-llamatokendataarray" class="md-nav__link">
  738. llama_sample_softmax(SafeLLamaContextHandle, LLamaTokenDataArray)
  739. </a>
  740. <nav class="md-nav" aria-label="llama_sample_softmax(SafeLLamaContextHandle, LLamaTokenDataArray)">
  741. <ul class="md-nav__list">
  742. <li class="md-nav__item">
  743. <a href="#parameters_5" class="md-nav__link">
  744. Parameters
  745. </a>
  746. </li>
  747. </ul>
  748. </nav>
  749. </li>
  750. <li class="md-nav__item">
  751. <a href="#llama_sample_top_ksafellamacontexthandle-llamatokendataarray-int32-uint64" class="md-nav__link">
  752. llama_sample_top_k(SafeLLamaContextHandle, LLamaTokenDataArray, Int32, UInt64)
  753. </a>
  754. <nav class="md-nav" aria-label="llama_sample_top_k(SafeLLamaContextHandle, LLamaTokenDataArray, Int32, UInt64)">
  755. <ul class="md-nav__list">
  756. <li class="md-nav__item">
  757. <a href="#parameters_6" class="md-nav__link">
  758. Parameters
  759. </a>
  760. </li>
  761. </ul>
  762. </nav>
  763. </li>
  764. <li class="md-nav__item">
  765. <a href="#llama_sample_top_psafellamacontexthandle-llamatokendataarray-single-uint64" class="md-nav__link">
  766. llama_sample_top_p(SafeLLamaContextHandle, LLamaTokenDataArray, Single, UInt64)
  767. </a>
  768. <nav class="md-nav" aria-label="llama_sample_top_p(SafeLLamaContextHandle, LLamaTokenDataArray, Single, UInt64)">
  769. <ul class="md-nav__list">
  770. <li class="md-nav__item">
  771. <a href="#parameters_7" class="md-nav__link">
  772. Parameters
  773. </a>
  774. </li>
  775. </ul>
  776. </nav>
  777. </li>
  778. <li class="md-nav__item">
  779. <a href="#llama_sample_tail_freesafellamacontexthandle-llamatokendataarray-single-uint64" class="md-nav__link">
  780. llama_sample_tail_free(SafeLLamaContextHandle, LLamaTokenDataArray, Single, UInt64)
  781. </a>
  782. <nav class="md-nav" aria-label="llama_sample_tail_free(SafeLLamaContextHandle, LLamaTokenDataArray, Single, UInt64)">
  783. <ul class="md-nav__list">
  784. <li class="md-nav__item">
  785. <a href="#parameters_8" class="md-nav__link">
  786. Parameters
  787. </a>
  788. </li>
  789. </ul>
  790. </nav>
  791. </li>
  792. <li class="md-nav__item">
  793. <a href="#llama_sample_typicalsafellamacontexthandle-llamatokendataarray-single-uint64" class="md-nav__link">
  794. llama_sample_typical(SafeLLamaContextHandle, LLamaTokenDataArray, Single, UInt64)
  795. </a>
  796. <nav class="md-nav" aria-label="llama_sample_typical(SafeLLamaContextHandle, LLamaTokenDataArray, Single, UInt64)">
  797. <ul class="md-nav__list">
  798. <li class="md-nav__item">
  799. <a href="#parameters_9" class="md-nav__link">
  800. Parameters
  801. </a>
  802. </li>
  803. </ul>
  804. </nav>
  805. </li>
  806. <li class="md-nav__item">
  807. <a href="#llama_sample_temperaturesafellamacontexthandle-llamatokendataarray-single" class="md-nav__link">
  808. llama_sample_temperature(SafeLLamaContextHandle, LLamaTokenDataArray, Single)
  809. </a>
  810. <nav class="md-nav" aria-label="llama_sample_temperature(SafeLLamaContextHandle, LLamaTokenDataArray, Single)">
  811. <ul class="md-nav__list">
  812. <li class="md-nav__item">
  813. <a href="#parameters_10" class="md-nav__link">
  814. Parameters
  815. </a>
  816. </li>
  817. </ul>
  818. </nav>
  819. </li>
  820. <li class="md-nav__item">
  821. <a href="#llama_sample_token_mirostatsafellamacontexthandle-llamatokendataarray-single-single-int32-single" class="md-nav__link">
  822. llama_sample_token_mirostat(SafeLLamaContextHandle, LLamaTokenDataArray, Single, Single, Int32, Single&amp;)
  823. </a>
  824. <nav class="md-nav" aria-label="llama_sample_token_mirostat(SafeLLamaContextHandle, LLamaTokenDataArray, Single, Single, Int32, Single&)">
  825. <ul class="md-nav__list">
  826. <li class="md-nav__item">
  827. <a href="#parameters_11" class="md-nav__link">
  828. Parameters
  829. </a>
  830. </li>
  831. <li class="md-nav__item">
  832. <a href="#returns" class="md-nav__link">
  833. Returns
  834. </a>
  835. </li>
  836. </ul>
  837. </nav>
  838. </li>
  839. <li class="md-nav__item">
  840. <a href="#llama_sample_token_mirostat_v2safellamacontexthandle-llamatokendataarray-single-single-single" class="md-nav__link">
  841. llama_sample_token_mirostat_v2(SafeLLamaContextHandle, LLamaTokenDataArray, Single, Single, Single&amp;)
  842. </a>
  843. <nav class="md-nav" aria-label="llama_sample_token_mirostat_v2(SafeLLamaContextHandle, LLamaTokenDataArray, Single, Single, Single&)">
  844. <ul class="md-nav__list">
  845. <li class="md-nav__item">
  846. <a href="#parameters_12" class="md-nav__link">
  847. Parameters
  848. </a>
  849. </li>
  850. <li class="md-nav__item">
  851. <a href="#returns_1" class="md-nav__link">
  852. Returns
  853. </a>
  854. </li>
  855. </ul>
  856. </nav>
  857. </li>
  858. <li class="md-nav__item">
  859. <a href="#llama_sample_token_greedysafellamacontexthandle-llamatokendataarray" class="md-nav__link">
  860. llama_sample_token_greedy(SafeLLamaContextHandle, LLamaTokenDataArray)
  861. </a>
  862. <nav class="md-nav" aria-label="llama_sample_token_greedy(SafeLLamaContextHandle, LLamaTokenDataArray)">
  863. <ul class="md-nav__list">
  864. <li class="md-nav__item">
  865. <a href="#parameters_13" class="md-nav__link">
  866. Parameters
  867. </a>
  868. </li>
  869. <li class="md-nav__item">
  870. <a href="#returns_2" class="md-nav__link">
  871. Returns
  872. </a>
  873. </li>
  874. </ul>
  875. </nav>
  876. </li>
  877. <li class="md-nav__item">
  878. <a href="#llama_sample_tokensafellamacontexthandle-llamatokendataarray" class="md-nav__link">
  879. llama_sample_token(SafeLLamaContextHandle, LLamaTokenDataArray)
  880. </a>
  881. <nav class="md-nav" aria-label="llama_sample_token(SafeLLamaContextHandle, LLamaTokenDataArray)">
  882. <ul class="md-nav__list">
  883. <li class="md-nav__item">
  884. <a href="#parameters_14" class="md-nav__link">
  885. Parameters
  886. </a>
  887. </li>
  888. <li class="md-nav__item">
  889. <a href="#returns_3" class="md-nav__link">
  890. Returns
  891. </a>
  892. </li>
  893. </ul>
  894. </nav>
  895. </li>
  896. </ul>
  897. </nav>
  898. </li>
  899. </ul>
  900. </nav>
  901. </li>
  902. <li class="md-nav__item">
  903. <a href="../llama.oldversion.chatcompletion/" class="md-nav__link">
  904. llama.oldversion.chatcompletion
  905. </a>
  906. </li>
  907. <li class="md-nav__item">
  908. <a href="../llama.oldversion.chatcompletionchoice/" class="md-nav__link">
  909. llama.oldversion.chatcompletionchoice
  910. </a>
  911. </li>
  912. <li class="md-nav__item">
  913. <a href="../llama.oldversion.chatcompletionchunk/" class="md-nav__link">
  914. llama.oldversion.chatcompletionchunk
  915. </a>
  916. </li>
  917. <li class="md-nav__item">
  918. <a href="../llama.oldversion.chatcompletionchunkchoice/" class="md-nav__link">
  919. llama.oldversion.chatcompletionchunkchoice
  920. </a>
  921. </li>
  922. <li class="md-nav__item">
  923. <a href="../llama.oldversion.chatcompletionchunkdelta/" class="md-nav__link">
  924. llama.oldversion.chatcompletionchunkdelta
  925. </a>
  926. </li>
  927. <li class="md-nav__item">
  928. <a href="../llama.oldversion.chatcompletionmessage/" class="md-nav__link">
  929. llama.oldversion.chatcompletionmessage
  930. </a>
  931. </li>
  932. <li class="md-nav__item">
  933. <a href="../llama.oldversion.chatmessagerecord/" class="md-nav__link">
  934. llama.oldversion.chatmessagerecord
  935. </a>
  936. </li>
  937. <li class="md-nav__item">
  938. <a href="../llama.oldversion.chatrole/" class="md-nav__link">
  939. llama.oldversion.chatrole
  940. </a>
  941. </li>
  942. <li class="md-nav__item">
  943. <a href="../llama.oldversion.chatsession-1/" class="md-nav__link">
  944. llama.oldversion.chatsession-1
  945. </a>
  946. </li>
  947. <li class="md-nav__item">
  948. <a href="../llama.oldversion.completion/" class="md-nav__link">
  949. llama.oldversion.completion
  950. </a>
  951. </li>
  952. <li class="md-nav__item">
  953. <a href="../llama.oldversion.completionchoice/" class="md-nav__link">
  954. llama.oldversion.completionchoice
  955. </a>
  956. </li>
  957. <li class="md-nav__item">
  958. <a href="../llama.oldversion.completionchunk/" class="md-nav__link">
  959. llama.oldversion.completionchunk
  960. </a>
  961. </li>
  962. <li class="md-nav__item">
  963. <a href="../llama.oldversion.completionlogprobs/" class="md-nav__link">
  964. llama.oldversion.completionlogprobs
  965. </a>
  966. </li>
  967. <li class="md-nav__item">
  968. <a href="../llama.oldversion.completionusage/" class="md-nav__link">
  969. llama.oldversion.completionusage
  970. </a>
  971. </li>
  972. <li class="md-nav__item">
  973. <a href="../llama.oldversion.embedding/" class="md-nav__link">
  974. llama.oldversion.embedding
  975. </a>
  976. </li>
  977. <li class="md-nav__item">
  978. <a href="../llama.oldversion.embeddingdata/" class="md-nav__link">
  979. llama.oldversion.embeddingdata
  980. </a>
  981. </li>
  982. <li class="md-nav__item">
  983. <a href="../llama.oldversion.embeddingusage/" class="md-nav__link">
  984. llama.oldversion.embeddingusage
  985. </a>
  986. </li>
  987. <li class="md-nav__item">
  988. <a href="../llama.oldversion.ichatmodel/" class="md-nav__link">
  989. llama.oldversion.ichatmodel
  990. </a>
  991. </li>
  992. <li class="md-nav__item">
  993. <a href="../llama.oldversion.llamaembedder/" class="md-nav__link">
  994. llama.oldversion.llamaembedder
  995. </a>
  996. </li>
  997. <li class="md-nav__item">
  998. <a href="../llama.oldversion.llamamodel/" class="md-nav__link">
  999. llama.oldversion.llamamodel
  1000. </a>
  1001. </li>
  1002. <li class="md-nav__item">
  1003. <a href="../llama.oldversion.llamaparams/" class="md-nav__link">
  1004. llama.oldversion.llamaparams
  1005. </a>
  1006. </li>
  1007. <li class="md-nav__item">
  1008. <a href="../llama.statefulexecutorbase/" class="md-nav__link">
  1009. llama.statefulexecutorbase
  1010. </a>
  1011. </li>
  1012. <li class="md-nav__item">
  1013. <a href="../llama.statelessexecutor/" class="md-nav__link">
  1014. llama.statelessexecutor
  1015. </a>
  1016. </li>
  1017. <li class="md-nav__item">
  1018. <a href="../llama.utils/" class="md-nav__link">
  1019. llama.utils
  1020. </a>
  1021. </li>
  1022. </ul>
  1023. </nav>
  1024. </li>
  1025. </ul>
  1026. </nav>
  1027. </div>
  1028. </div>
  1029. </div>
  1030. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1031. <div class="md-sidebar__scrollwrap">
  1032. <div class="md-sidebar__inner">
  1033. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1034. <label class="md-nav__title" for="__toc">
  1035. <span class="md-nav__icon md-icon"></span>
  1036. Table of contents
  1037. </label>
  1038. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1039. <li class="md-nav__item">
  1040. <a href="#constructors" class="md-nav__link">
  1041. Constructors
  1042. </a>
  1043. <nav class="md-nav" aria-label="Constructors">
  1044. <ul class="md-nav__list">
  1045. <li class="md-nav__item">
  1046. <a href="#samplingapi_1" class="md-nav__link">
  1047. SamplingApi()
  1048. </a>
  1049. </li>
  1050. </ul>
  1051. </nav>
  1052. </li>
  1053. <li class="md-nav__item">
  1054. <a href="#methods" class="md-nav__link">
  1055. Methods
  1056. </a>
  1057. <nav class="md-nav" aria-label="Methods">
  1058. <ul class="md-nav__list">
  1059. <li class="md-nav__item">
  1060. <a href="#llama_sample_grammarsafellamacontexthandle-llamatokendataarray-safellamagrammarhandle" class="md-nav__link">
  1061. llama_sample_grammar(SafeLLamaContextHandle, LLamaTokenDataArray, SafeLLamaGrammarHandle)
  1062. </a>
  1063. <nav class="md-nav" aria-label="llama_sample_grammar(SafeLLamaContextHandle, LLamaTokenDataArray, SafeLLamaGrammarHandle)">
  1064. <ul class="md-nav__list">
  1065. <li class="md-nav__item">
  1066. <a href="#parameters" class="md-nav__link">
  1067. Parameters
  1068. </a>
  1069. </li>
  1070. </ul>
  1071. </nav>
  1072. </li>
  1073. <li class="md-nav__item">
  1074. <a href="#llama_sample_repetition_penaltysafellamacontexthandle-llamatokendataarray-memoryint32-uint64-single" class="md-nav__link">
  1075. llama_sample_repetition_penalty(SafeLLamaContextHandle, LLamaTokenDataArray, Memory&lt;Int32&gt;, UInt64, Single)
  1076. </a>
  1077. <nav class="md-nav" aria-label="llama_sample_repetition_penalty(SafeLLamaContextHandle, LLamaTokenDataArray, Memory<Int32>, UInt64, Single)">
  1078. <ul class="md-nav__list">
  1079. <li class="md-nav__item">
  1080. <a href="#caution" class="md-nav__link">
  1081. Caution
  1082. </a>
  1083. </li>
  1084. <li class="md-nav__item">
  1085. <a href="#parameters_1" class="md-nav__link">
  1086. Parameters
  1087. </a>
  1088. </li>
  1089. </ul>
  1090. </nav>
  1091. </li>
  1092. <li class="md-nav__item">
  1093. <a href="#llama_sample_repetition_penaltysafellamacontexthandle-llamatokendataarray-memoryint32-single" class="md-nav__link">
  1094. llama_sample_repetition_penalty(SafeLLamaContextHandle, LLamaTokenDataArray, Memory&lt;Int32&gt;, Single)
  1095. </a>
  1096. <nav class="md-nav" aria-label="llama_sample_repetition_penalty(SafeLLamaContextHandle, LLamaTokenDataArray, Memory<Int32>, Single)">
  1097. <ul class="md-nav__list">
  1098. <li class="md-nav__item">
  1099. <a href="#parameters_2" class="md-nav__link">
  1100. Parameters
  1101. </a>
  1102. </li>
  1103. </ul>
  1104. </nav>
  1105. </li>
  1106. <li class="md-nav__item">
  1107. <a href="#llama_sample_frequency_and_presence_penaltiessafellamacontexthandle-llamatokendataarray-memoryint32-uint64-single-single" class="md-nav__link">
  1108. llama_sample_frequency_and_presence_penalties(SafeLLamaContextHandle, LLamaTokenDataArray, Memory&lt;Int32&gt;, UInt64, Single, Single)
  1109. </a>
  1110. <nav class="md-nav" aria-label="llama_sample_frequency_and_presence_penalties(SafeLLamaContextHandle, LLamaTokenDataArray, Memory<Int32>, UInt64, Single, Single)">
  1111. <ul class="md-nav__list">
  1112. <li class="md-nav__item">
  1113. <a href="#caution_1" class="md-nav__link">
  1114. Caution
  1115. </a>
  1116. </li>
  1117. <li class="md-nav__item">
  1118. <a href="#parameters_3" class="md-nav__link">
  1119. Parameters
  1120. </a>
  1121. </li>
  1122. </ul>
  1123. </nav>
  1124. </li>
  1125. <li class="md-nav__item">
  1126. <a href="#llama_sample_frequency_and_presence_penaltiessafellamacontexthandle-llamatokendataarray-memoryint32-single-single" class="md-nav__link">
  1127. llama_sample_frequency_and_presence_penalties(SafeLLamaContextHandle, LLamaTokenDataArray, Memory&lt;Int32&gt;, Single, Single)
  1128. </a>
  1129. <nav class="md-nav" aria-label="llama_sample_frequency_and_presence_penalties(SafeLLamaContextHandle, LLamaTokenDataArray, Memory<Int32>, Single, Single)">
  1130. <ul class="md-nav__list">
  1131. <li class="md-nav__item">
  1132. <a href="#parameters_4" class="md-nav__link">
  1133. Parameters
  1134. </a>
  1135. </li>
  1136. </ul>
  1137. </nav>
  1138. </li>
  1139. <li class="md-nav__item">
  1140. <a href="#llama_sample_softmaxsafellamacontexthandle-llamatokendataarray" class="md-nav__link">
  1141. llama_sample_softmax(SafeLLamaContextHandle, LLamaTokenDataArray)
  1142. </a>
  1143. <nav class="md-nav" aria-label="llama_sample_softmax(SafeLLamaContextHandle, LLamaTokenDataArray)">
  1144. <ul class="md-nav__list">
  1145. <li class="md-nav__item">
  1146. <a href="#parameters_5" class="md-nav__link">
  1147. Parameters
  1148. </a>
  1149. </li>
  1150. </ul>
  1151. </nav>
  1152. </li>
  1153. <li class="md-nav__item">
  1154. <a href="#llama_sample_top_ksafellamacontexthandle-llamatokendataarray-int32-uint64" class="md-nav__link">
  1155. llama_sample_top_k(SafeLLamaContextHandle, LLamaTokenDataArray, Int32, UInt64)
  1156. </a>
  1157. <nav class="md-nav" aria-label="llama_sample_top_k(SafeLLamaContextHandle, LLamaTokenDataArray, Int32, UInt64)">
  1158. <ul class="md-nav__list">
  1159. <li class="md-nav__item">
  1160. <a href="#parameters_6" class="md-nav__link">
  1161. Parameters
  1162. </a>
  1163. </li>
  1164. </ul>
  1165. </nav>
  1166. </li>
  1167. <li class="md-nav__item">
  1168. <a href="#llama_sample_top_psafellamacontexthandle-llamatokendataarray-single-uint64" class="md-nav__link">
  1169. llama_sample_top_p(SafeLLamaContextHandle, LLamaTokenDataArray, Single, UInt64)
  1170. </a>
  1171. <nav class="md-nav" aria-label="llama_sample_top_p(SafeLLamaContextHandle, LLamaTokenDataArray, Single, UInt64)">
  1172. <ul class="md-nav__list">
  1173. <li class="md-nav__item">
  1174. <a href="#parameters_7" class="md-nav__link">
  1175. Parameters
  1176. </a>
  1177. </li>
  1178. </ul>
  1179. </nav>
  1180. </li>
  1181. <li class="md-nav__item">
  1182. <a href="#llama_sample_tail_freesafellamacontexthandle-llamatokendataarray-single-uint64" class="md-nav__link">
  1183. llama_sample_tail_free(SafeLLamaContextHandle, LLamaTokenDataArray, Single, UInt64)
  1184. </a>
  1185. <nav class="md-nav" aria-label="llama_sample_tail_free(SafeLLamaContextHandle, LLamaTokenDataArray, Single, UInt64)">
  1186. <ul class="md-nav__list">
  1187. <li class="md-nav__item">
  1188. <a href="#parameters_8" class="md-nav__link">
  1189. Parameters
  1190. </a>
  1191. </li>
  1192. </ul>
  1193. </nav>
  1194. </li>
  1195. <li class="md-nav__item">
  1196. <a href="#llama_sample_typicalsafellamacontexthandle-llamatokendataarray-single-uint64" class="md-nav__link">
  1197. llama_sample_typical(SafeLLamaContextHandle, LLamaTokenDataArray, Single, UInt64)
  1198. </a>
  1199. <nav class="md-nav" aria-label="llama_sample_typical(SafeLLamaContextHandle, LLamaTokenDataArray, Single, UInt64)">
  1200. <ul class="md-nav__list">
  1201. <li class="md-nav__item">
  1202. <a href="#parameters_9" class="md-nav__link">
  1203. Parameters
  1204. </a>
  1205. </li>
  1206. </ul>
  1207. </nav>
  1208. </li>
  1209. <li class="md-nav__item">
  1210. <a href="#llama_sample_temperaturesafellamacontexthandle-llamatokendataarray-single" class="md-nav__link">
  1211. llama_sample_temperature(SafeLLamaContextHandle, LLamaTokenDataArray, Single)
  1212. </a>
  1213. <nav class="md-nav" aria-label="llama_sample_temperature(SafeLLamaContextHandle, LLamaTokenDataArray, Single)">
  1214. <ul class="md-nav__list">
  1215. <li class="md-nav__item">
  1216. <a href="#parameters_10" class="md-nav__link">
  1217. Parameters
  1218. </a>
  1219. </li>
  1220. </ul>
  1221. </nav>
  1222. </li>
  1223. <li class="md-nav__item">
  1224. <a href="#llama_sample_token_mirostatsafellamacontexthandle-llamatokendataarray-single-single-int32-single" class="md-nav__link">
  1225. llama_sample_token_mirostat(SafeLLamaContextHandle, LLamaTokenDataArray, Single, Single, Int32, Single&amp;)
  1226. </a>
  1227. <nav class="md-nav" aria-label="llama_sample_token_mirostat(SafeLLamaContextHandle, LLamaTokenDataArray, Single, Single, Int32, Single&)">
  1228. <ul class="md-nav__list">
  1229. <li class="md-nav__item">
  1230. <a href="#parameters_11" class="md-nav__link">
  1231. Parameters
  1232. </a>
  1233. </li>
  1234. <li class="md-nav__item">
  1235. <a href="#returns" class="md-nav__link">
  1236. Returns
  1237. </a>
  1238. </li>
  1239. </ul>
  1240. </nav>
  1241. </li>
  1242. <li class="md-nav__item">
  1243. <a href="#llama_sample_token_mirostat_v2safellamacontexthandle-llamatokendataarray-single-single-single" class="md-nav__link">
  1244. llama_sample_token_mirostat_v2(SafeLLamaContextHandle, LLamaTokenDataArray, Single, Single, Single&amp;)
  1245. </a>
  1246. <nav class="md-nav" aria-label="llama_sample_token_mirostat_v2(SafeLLamaContextHandle, LLamaTokenDataArray, Single, Single, Single&)">
  1247. <ul class="md-nav__list">
  1248. <li class="md-nav__item">
  1249. <a href="#parameters_12" class="md-nav__link">
  1250. Parameters
  1251. </a>
  1252. </li>
  1253. <li class="md-nav__item">
  1254. <a href="#returns_1" class="md-nav__link">
  1255. Returns
  1256. </a>
  1257. </li>
  1258. </ul>
  1259. </nav>
  1260. </li>
  1261. <li class="md-nav__item">
  1262. <a href="#llama_sample_token_greedysafellamacontexthandle-llamatokendataarray" class="md-nav__link">
  1263. llama_sample_token_greedy(SafeLLamaContextHandle, LLamaTokenDataArray)
  1264. </a>
  1265. <nav class="md-nav" aria-label="llama_sample_token_greedy(SafeLLamaContextHandle, LLamaTokenDataArray)">
  1266. <ul class="md-nav__list">
  1267. <li class="md-nav__item">
  1268. <a href="#parameters_13" class="md-nav__link">
  1269. Parameters
  1270. </a>
  1271. </li>
  1272. <li class="md-nav__item">
  1273. <a href="#returns_2" class="md-nav__link">
  1274. Returns
  1275. </a>
  1276. </li>
  1277. </ul>
  1278. </nav>
  1279. </li>
  1280. <li class="md-nav__item">
  1281. <a href="#llama_sample_tokensafellamacontexthandle-llamatokendataarray" class="md-nav__link">
  1282. llama_sample_token(SafeLLamaContextHandle, LLamaTokenDataArray)
  1283. </a>
  1284. <nav class="md-nav" aria-label="llama_sample_token(SafeLLamaContextHandle, LLamaTokenDataArray)">
  1285. <ul class="md-nav__list">
  1286. <li class="md-nav__item">
  1287. <a href="#parameters_14" class="md-nav__link">
  1288. Parameters
  1289. </a>
  1290. </li>
  1291. <li class="md-nav__item">
  1292. <a href="#returns_3" class="md-nav__link">
  1293. Returns
  1294. </a>
  1295. </li>
  1296. </ul>
  1297. </nav>
  1298. </li>
  1299. </ul>
  1300. </nav>
  1301. </li>
  1302. </ul>
  1303. </nav>
  1304. </div>
  1305. </div>
  1306. </div>
  1307. <div class="md-content" data-md-component="content">
  1308. <article class="md-content__inner md-typeset">
  1309. <h1 id="samplingapi">SamplingApi</h1>
  1310. <p>Namespace: LLama.Native</p>
  1311. <p>Direct translation of the llama.cpp sampling API</p>
  1312. <pre><code class="language-csharp">public class SamplingApi
  1313. </code></pre>
  1314. <p>Inheritance <a href="https://docs.microsoft.com/en-us/dotnet/api/system.object">Object</a> → <a href="./">SamplingApi</a></p>
  1315. <h2 id="constructors">Constructors</h2>
  1316. <h3 id="samplingapi_1"><strong>SamplingApi()</strong></h3>
  1317. <pre><code class="language-csharp">public SamplingApi()
  1318. </code></pre>
  1319. <h2 id="methods">Methods</h2>
  1320. <h3 id="llama_sample_grammarsafellamacontexthandle-llamatokendataarray-safellamagrammarhandle"><strong>llama_sample_grammar(SafeLLamaContextHandle, LLamaTokenDataArray, SafeLLamaGrammarHandle)</strong></h3>
  1321. <p>Apply grammar rules to candidate tokens</p>
  1322. <pre><code class="language-csharp">public static void llama_sample_grammar(SafeLLamaContextHandle ctx, LLamaTokenDataArray candidates, SafeLLamaGrammarHandle grammar)
  1323. </code></pre>
  1324. <h4 id="parameters">Parameters</h4>
  1325. <p><code>ctx</code> <a href="../llama.native.safellamacontexthandle/">SafeLLamaContextHandle</a><br></p>
  1326. <p><code>candidates</code> <a href="../llama.native.llamatokendataarray/">LLamaTokenDataArray</a><br></p>
  1327. <p><code>grammar</code> <a href="../llama.native.safellamagrammarhandle/">SafeLLamaGrammarHandle</a><br></p>
  1328. <h3 id="llama_sample_repetition_penaltysafellamacontexthandle-llamatokendataarray-memoryint32-uint64-single"><strong>llama_sample_repetition_penalty(SafeLLamaContextHandle, LLamaTokenDataArray, Memory&lt;Int32&gt;, UInt64, Single)</strong></h3>
  1329. <h4 id="caution">Caution</h4>
  1330. <p>last_tokens_size parameter is no longer needed</p>
  1331. <hr />
  1332. <p>Repetition penalty described in CTRL academic paper https://arxiv.org/abs/1909.05858, with negative logit fix.</p>
  1333. <pre><code class="language-csharp">public static void llama_sample_repetition_penalty(SafeLLamaContextHandle ctx, LLamaTokenDataArray candidates, Memory&lt;int&gt; last_tokens, ulong last_tokens_size, float penalty)
  1334. </code></pre>
  1335. <h4 id="parameters_1">Parameters</h4>
  1336. <p><code>ctx</code> <a href="../llama.native.safellamacontexthandle/">SafeLLamaContextHandle</a><br></p>
  1337. <p><code>candidates</code> <a href="../llama.native.llamatokendataarray/">LLamaTokenDataArray</a><br>
  1338. Pointer to LLamaTokenDataArray</p>
  1339. <p><code>last_tokens</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.memory-1">Memory&lt;Int32&gt;</a><br></p>
  1340. <p><code>last_tokens_size</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.uint64">UInt64</a><br></p>
  1341. <p><code>penalty</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single">Single</a><br></p>
  1342. <h3 id="llama_sample_repetition_penaltysafellamacontexthandle-llamatokendataarray-memoryint32-single"><strong>llama_sample_repetition_penalty(SafeLLamaContextHandle, LLamaTokenDataArray, Memory&lt;Int32&gt;, Single)</strong></h3>
  1343. <p>Repetition penalty described in CTRL academic paper https://arxiv.org/abs/1909.05858, with negative logit fix.</p>
  1344. <pre><code class="language-csharp">public static void llama_sample_repetition_penalty(SafeLLamaContextHandle ctx, LLamaTokenDataArray candidates, Memory&lt;int&gt; last_tokens, float penalty)
  1345. </code></pre>
  1346. <h4 id="parameters_2">Parameters</h4>
  1347. <p><code>ctx</code> <a href="../llama.native.safellamacontexthandle/">SafeLLamaContextHandle</a><br></p>
  1348. <p><code>candidates</code> <a href="../llama.native.llamatokendataarray/">LLamaTokenDataArray</a><br>
  1349. Pointer to LLamaTokenDataArray</p>
  1350. <p><code>last_tokens</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.memory-1">Memory&lt;Int32&gt;</a><br></p>
  1351. <p><code>penalty</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single">Single</a><br></p>
  1352. <h3 id="llama_sample_frequency_and_presence_penaltiessafellamacontexthandle-llamatokendataarray-memoryint32-uint64-single-single"><strong>llama_sample_frequency_and_presence_penalties(SafeLLamaContextHandle, LLamaTokenDataArray, Memory&lt;Int32&gt;, UInt64, Single, Single)</strong></h3>
  1353. <h4 id="caution_1">Caution</h4>
  1354. <p>last_tokens_size parameter is no longer needed</p>
  1355. <hr />
  1356. <p>Frequency and presence penalties described in OpenAI API https://platform.openai.com/docs/api-reference/parameter-details.</p>
  1357. <pre><code class="language-csharp">public static void llama_sample_frequency_and_presence_penalties(SafeLLamaContextHandle ctx, LLamaTokenDataArray candidates, Memory&lt;int&gt; last_tokens, ulong last_tokens_size, float alpha_frequency, float alpha_presence)
  1358. </code></pre>
  1359. <h4 id="parameters_3">Parameters</h4>
  1360. <p><code>ctx</code> <a href="../llama.native.safellamacontexthandle/">SafeLLamaContextHandle</a><br></p>
  1361. <p><code>candidates</code> <a href="../llama.native.llamatokendataarray/">LLamaTokenDataArray</a><br>
  1362. Pointer to LLamaTokenDataArray</p>
  1363. <p><code>last_tokens</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.memory-1">Memory&lt;Int32&gt;</a><br></p>
  1364. <p><code>last_tokens_size</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.uint64">UInt64</a><br></p>
  1365. <p><code>alpha_frequency</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single">Single</a><br></p>
  1366. <p><code>alpha_presence</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single">Single</a><br></p>
  1367. <h3 id="llama_sample_frequency_and_presence_penaltiessafellamacontexthandle-llamatokendataarray-memoryint32-single-single"><strong>llama_sample_frequency_and_presence_penalties(SafeLLamaContextHandle, LLamaTokenDataArray, Memory&lt;Int32&gt;, Single, Single)</strong></h3>
  1368. <p>Frequency and presence penalties described in OpenAI API https://platform.openai.com/docs/api-reference/parameter-details.</p>
  1369. <pre><code class="language-csharp">public static void llama_sample_frequency_and_presence_penalties(SafeLLamaContextHandle ctx, LLamaTokenDataArray candidates, Memory&lt;int&gt; last_tokens, float alpha_frequency, float alpha_presence)
  1370. </code></pre>
  1371. <h4 id="parameters_4">Parameters</h4>
  1372. <p><code>ctx</code> <a href="../llama.native.safellamacontexthandle/">SafeLLamaContextHandle</a><br></p>
  1373. <p><code>candidates</code> <a href="../llama.native.llamatokendataarray/">LLamaTokenDataArray</a><br>
  1374. Pointer to LLamaTokenDataArray</p>
  1375. <p><code>last_tokens</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.memory-1">Memory&lt;Int32&gt;</a><br></p>
  1376. <p><code>alpha_frequency</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single">Single</a><br></p>
  1377. <p><code>alpha_presence</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single">Single</a><br></p>
  1378. <h3 id="llama_sample_softmaxsafellamacontexthandle-llamatokendataarray"><strong>llama_sample_softmax(SafeLLamaContextHandle, LLamaTokenDataArray)</strong></h3>
  1379. <p>Sorts candidate tokens by their logits in descending order and calculate probabilities based on logits.</p>
  1380. <pre><code class="language-csharp">public static void llama_sample_softmax(SafeLLamaContextHandle ctx, LLamaTokenDataArray candidates)
  1381. </code></pre>
  1382. <h4 id="parameters_5">Parameters</h4>
  1383. <p><code>ctx</code> <a href="../llama.native.safellamacontexthandle/">SafeLLamaContextHandle</a><br></p>
  1384. <p><code>candidates</code> <a href="../llama.native.llamatokendataarray/">LLamaTokenDataArray</a><br>
  1385. Pointer to LLamaTokenDataArray</p>
  1386. <h3 id="llama_sample_top_ksafellamacontexthandle-llamatokendataarray-int32-uint64"><strong>llama_sample_top_k(SafeLLamaContextHandle, LLamaTokenDataArray, Int32, UInt64)</strong></h3>
  1387. <p>Top-K sampling described in academic paper "The Curious Case of Neural Text Degeneration" https://arxiv.org/abs/1904.09751</p>
  1388. <pre><code class="language-csharp">public static void llama_sample_top_k(SafeLLamaContextHandle ctx, LLamaTokenDataArray candidates, int k, ulong min_keep)
  1389. </code></pre>
  1390. <h4 id="parameters_6">Parameters</h4>
  1391. <p><code>ctx</code> <a href="../llama.native.safellamacontexthandle/">SafeLLamaContextHandle</a><br></p>
  1392. <p><code>candidates</code> <a href="../llama.native.llamatokendataarray/">LLamaTokenDataArray</a><br>
  1393. Pointer to LLamaTokenDataArray</p>
  1394. <p><code>k</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.int32">Int32</a><br></p>
  1395. <p><code>min_keep</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.uint64">UInt64</a><br></p>
  1396. <h3 id="llama_sample_top_psafellamacontexthandle-llamatokendataarray-single-uint64"><strong>llama_sample_top_p(SafeLLamaContextHandle, LLamaTokenDataArray, Single, UInt64)</strong></h3>
  1397. <p>Nucleus sampling described in academic paper "The Curious Case of Neural Text Degeneration" https://arxiv.org/abs/1904.09751</p>
  1398. <pre><code class="language-csharp">public static void llama_sample_top_p(SafeLLamaContextHandle ctx, LLamaTokenDataArray candidates, float p, ulong min_keep)
  1399. </code></pre>
  1400. <h4 id="parameters_7">Parameters</h4>
  1401. <p><code>ctx</code> <a href="../llama.native.safellamacontexthandle/">SafeLLamaContextHandle</a><br></p>
  1402. <p><code>candidates</code> <a href="../llama.native.llamatokendataarray/">LLamaTokenDataArray</a><br>
  1403. Pointer to LLamaTokenDataArray</p>
  1404. <p><code>p</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single">Single</a><br></p>
  1405. <p><code>min_keep</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.uint64">UInt64</a><br></p>
  1406. <h3 id="llama_sample_tail_freesafellamacontexthandle-llamatokendataarray-single-uint64"><strong>llama_sample_tail_free(SafeLLamaContextHandle, LLamaTokenDataArray, Single, UInt64)</strong></h3>
  1407. <p>Tail Free Sampling described in https://www.trentonbricken.com/Tail-Free-Sampling/.</p>
  1408. <pre><code class="language-csharp">public static void llama_sample_tail_free(SafeLLamaContextHandle ctx, LLamaTokenDataArray candidates, float z, ulong min_keep)
  1409. </code></pre>
  1410. <h4 id="parameters_8">Parameters</h4>
  1411. <p><code>ctx</code> <a href="../llama.native.safellamacontexthandle/">SafeLLamaContextHandle</a><br></p>
  1412. <p><code>candidates</code> <a href="../llama.native.llamatokendataarray/">LLamaTokenDataArray</a><br>
  1413. Pointer to LLamaTokenDataArray</p>
  1414. <p><code>z</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single">Single</a><br></p>
  1415. <p><code>min_keep</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.uint64">UInt64</a><br></p>
  1416. <h3 id="llama_sample_typicalsafellamacontexthandle-llamatokendataarray-single-uint64"><strong>llama_sample_typical(SafeLLamaContextHandle, LLamaTokenDataArray, Single, UInt64)</strong></h3>
  1417. <p>Locally Typical Sampling implementation described in the paper https://arxiv.org/abs/2202.00666.</p>
  1418. <pre><code class="language-csharp">public static void llama_sample_typical(SafeLLamaContextHandle ctx, LLamaTokenDataArray candidates, float p, ulong min_keep)
  1419. </code></pre>
  1420. <h4 id="parameters_9">Parameters</h4>
  1421. <p><code>ctx</code> <a href="../llama.native.safellamacontexthandle/">SafeLLamaContextHandle</a><br></p>
  1422. <p><code>candidates</code> <a href="../llama.native.llamatokendataarray/">LLamaTokenDataArray</a><br>
  1423. Pointer to LLamaTokenDataArray</p>
  1424. <p><code>p</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single">Single</a><br></p>
  1425. <p><code>min_keep</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.uint64">UInt64</a><br></p>
  1426. <h3 id="llama_sample_temperaturesafellamacontexthandle-llamatokendataarray-single"><strong>llama_sample_temperature(SafeLLamaContextHandle, LLamaTokenDataArray, Single)</strong></h3>
  1427. <p>Sample with temperature.
  1428. As temperature increases, the prediction becomes diverse but also vulnerable to hallucinations -- generating tokens that are sensible but not factual</p>
  1429. <pre><code class="language-csharp">public static void llama_sample_temperature(SafeLLamaContextHandle ctx, LLamaTokenDataArray candidates, float temp)
  1430. </code></pre>
  1431. <h4 id="parameters_10">Parameters</h4>
  1432. <p><code>ctx</code> <a href="../llama.native.safellamacontexthandle/">SafeLLamaContextHandle</a><br></p>
  1433. <p><code>candidates</code> <a href="../llama.native.llamatokendataarray/">LLamaTokenDataArray</a><br></p>
  1434. <p><code>temp</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single">Single</a><br></p>
  1435. <h3 id="llama_sample_token_mirostatsafellamacontexthandle-llamatokendataarray-single-single-int32-single"><strong>llama_sample_token_mirostat(SafeLLamaContextHandle, LLamaTokenDataArray, Single, Single, Int32, Single&amp;)</strong></h3>
  1436. <p>Mirostat 1.0 algorithm described in the paper https://arxiv.org/abs/2007.14966. Uses tokens instead of words.</p>
  1437. <pre><code class="language-csharp">public static int llama_sample_token_mirostat(SafeLLamaContextHandle ctx, LLamaTokenDataArray candidates, float tau, float eta, int m, Single&amp; mu)
  1438. </code></pre>
  1439. <h4 id="parameters_11">Parameters</h4>
  1440. <p><code>ctx</code> <a href="../llama.native.safellamacontexthandle/">SafeLLamaContextHandle</a><br></p>
  1441. <p><code>candidates</code> <a href="../llama.native.llamatokendataarray/">LLamaTokenDataArray</a><br>
  1442. 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>
  1443. <p><code>tau</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single">Single</a><br>
  1444. 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>
  1445. <p><code>eta</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single">Single</a><br>
  1446. 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>
  1447. <p><code>m</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.int32">Int32</a><br>
  1448. 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>
  1449. <p><code>mu</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single&amp;">Single&amp;</a><br>
  1450. 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>
  1451. <h4 id="returns">Returns</h4>
  1452. <p><a href="https://docs.microsoft.com/en-us/dotnet/api/system.int32">Int32</a><br></p>
  1453. <h3 id="llama_sample_token_mirostat_v2safellamacontexthandle-llamatokendataarray-single-single-single"><strong>llama_sample_token_mirostat_v2(SafeLLamaContextHandle, LLamaTokenDataArray, Single, Single, Single&amp;)</strong></h3>
  1454. <p>Mirostat 2.0 algorithm described in the paper https://arxiv.org/abs/2007.14966. Uses tokens instead of words.</p>
  1455. <pre><code class="language-csharp">public static int llama_sample_token_mirostat_v2(SafeLLamaContextHandle ctx, LLamaTokenDataArray candidates, float tau, float eta, Single&amp; mu)
  1456. </code></pre>
  1457. <h4 id="parameters_12">Parameters</h4>
  1458. <p><code>ctx</code> <a href="../llama.native.safellamacontexthandle/">SafeLLamaContextHandle</a><br></p>
  1459. <p><code>candidates</code> <a href="../llama.native.llamatokendataarray/">LLamaTokenDataArray</a><br>
  1460. 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>
  1461. <p><code>tau</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single">Single</a><br>
  1462. 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>
  1463. <p><code>eta</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single">Single</a><br>
  1464. 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>
  1465. <p><code>mu</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.single&amp;">Single&amp;</a><br>
  1466. 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>
  1467. <h4 id="returns_1">Returns</h4>
  1468. <p><a href="https://docs.microsoft.com/en-us/dotnet/api/system.int32">Int32</a><br></p>
  1469. <h3 id="llama_sample_token_greedysafellamacontexthandle-llamatokendataarray"><strong>llama_sample_token_greedy(SafeLLamaContextHandle, LLamaTokenDataArray)</strong></h3>
  1470. <p>Selects the token with the highest probability.</p>
  1471. <pre><code class="language-csharp">public static int llama_sample_token_greedy(SafeLLamaContextHandle ctx, LLamaTokenDataArray candidates)
  1472. </code></pre>
  1473. <h4 id="parameters_13">Parameters</h4>
  1474. <p><code>ctx</code> <a href="../llama.native.safellamacontexthandle/">SafeLLamaContextHandle</a><br></p>
  1475. <p><code>candidates</code> <a href="../llama.native.llamatokendataarray/">LLamaTokenDataArray</a><br>
  1476. Pointer to LLamaTokenDataArray</p>
  1477. <h4 id="returns_2">Returns</h4>
  1478. <p><a href="https://docs.microsoft.com/en-us/dotnet/api/system.int32">Int32</a><br></p>
  1479. <h3 id="llama_sample_tokensafellamacontexthandle-llamatokendataarray"><strong>llama_sample_token(SafeLLamaContextHandle, LLamaTokenDataArray)</strong></h3>
  1480. <p>Randomly selects a token from the candidates based on their probabilities.</p>
  1481. <pre><code class="language-csharp">public static int llama_sample_token(SafeLLamaContextHandle ctx, LLamaTokenDataArray candidates)
  1482. </code></pre>
  1483. <h4 id="parameters_14">Parameters</h4>
  1484. <p><code>ctx</code> <a href="../llama.native.safellamacontexthandle/">SafeLLamaContextHandle</a><br></p>
  1485. <p><code>candidates</code> <a href="../llama.native.llamatokendataarray/">LLamaTokenDataArray</a><br>
  1486. Pointer to LLamaTokenDataArray</p>
  1487. <h4 id="returns_3">Returns</h4>
  1488. <p><a href="https://docs.microsoft.com/en-us/dotnet/api/system.int32">Int32</a><br></p>
  1489. </article>
  1490. </div>
  1491. </div>
  1492. </main>
  1493. <footer class="md-footer">
  1494. <div class="md-footer-meta md-typeset">
  1495. <div class="md-footer-meta__inner md-grid">
  1496. <div class="md-copyright">
  1497. Made with
  1498. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1499. Material for MkDocs
  1500. </a>
  1501. </div>
  1502. </div>
  1503. </div>
  1504. </footer>
  1505. </div>
  1506. <div class="md-dialog" data-md-component="dialog">
  1507. <div class="md-dialog__inner md-typeset"></div>
  1508. </div>
  1509. <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>
  1510. <script src="../../assets/javascripts/bundle.a51614de.min.js"></script>
  1511. </body>
  1512. </html>

C#/.NET上易用的LLM高性能推理框架,支持LLaMA和LLaVA系列模型。

Contributors (1)