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 60 kB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877
  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="next" href="QuickStart/">
  7. <link rel="icon" href="media/icon128.png">
  8. <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.20">
  9. <title>LLamaSharp Documentation</title>
  10. <link rel="stylesheet" href="assets/stylesheets/main.eebd395e.min.css">
  11. <link rel="stylesheet" href="assets/stylesheets/palette.ecc896b0.min.css">
  12. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  13. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Fira+Sans:300,300i,400,400i,700,700i%7CFira+Mono:400,400i,700,700i&display=fallback">
  14. <style>:root{--md-text-font:"Fira Sans";--md-code-font:"Fira Mono"}</style>
  15. <link rel="stylesheet" href="css/extra.css?v=14">
  16. <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>
  17. </head>
  18. <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="white" data-md-color-accent="red">
  19. <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>
  20. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  21. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  22. <label class="md-overlay" for="__drawer"></label>
  23. <div data-md-component="skip">
  24. <a href="#overview" class="md-skip">
  25. Skip to content
  26. </a>
  27. </div>
  28. <div data-md-component="announce">
  29. </div>
  30. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  31. </div>
  32. <header class="md-header md-header--shadow" data-md-component="header">
  33. <nav class="md-header__inner md-grid" aria-label="Header">
  34. <a href="." title="LLamaSharp Documentation" class="md-header__button md-logo" aria-label="LLamaSharp Documentation" data-md-component="logo">
  35. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 9h5.5L13 3.5V9M6 2h8l6 6v12a2 2 0 0 1-2 2H6a2 2 0 0 1-2-2V4c0-1.11.89-2 2-2m9 16v-2H6v2h9m3-4v-2H6v2h12Z"/></svg>
  36. </a>
  37. <label class="md-header__button md-icon" for="__drawer">
  38. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
  39. </label>
  40. <div class="md-header__title" data-md-component="header-title">
  41. <div class="md-header__ellipsis">
  42. <div class="md-header__topic">
  43. <span class="md-ellipsis">
  44. LLamaSharp Documentation
  45. </span>
  46. </div>
  47. <div class="md-header__topic" data-md-component="header-topic">
  48. <span class="md-ellipsis">
  49. Overview
  50. </span>
  51. </div>
  52. </div>
  53. </div>
  54. <form class="md-header__option" data-md-component="palette">
  55. <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="white" data-md-color-accent="red" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
  56. <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
  57. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 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-7 2.39 3.42C13.65 5.15 12.84 5 12 5c-.84 0-1.65.15-2.39.42L12 2M3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29L3.34 7m.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14L3.36 17M20.65 7l-1.77 3.79a7.023 7.023 0 0 0-2.38-4.15l4.15.36m-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29L20.64 17M12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44L12 22Z"/></svg>
  58. </label>
  59. <input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="blue" data-md-color-accent="blue" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
  60. <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
  61. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3 3.19.09m3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95 2.06.05m-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31Z"/></svg>
  62. </label>
  63. </form>
  64. <label class="md-header__button md-icon" for="__search">
  65. <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>
  66. </label>
  67. <div class="md-search" data-md-component="search" role="dialog">
  68. <label class="md-search__overlay" for="__search"></label>
  69. <div class="md-search__inner" role="search">
  70. <form class="md-search__form" name="search">
  71. <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>
  72. <label class="md-search__icon md-icon" for="__search">
  73. <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>
  74. <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>
  75. </label>
  76. <nav class="md-search__options" aria-label="Search">
  77. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  78. <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>
  79. </button>
  80. </nav>
  81. </form>
  82. <div class="md-search__output">
  83. <div class="md-search__scrollwrap" data-md-scrollfix>
  84. <div class="md-search-result" data-md-component="search-result">
  85. <div class="md-search-result__meta">
  86. Initializing search
  87. </div>
  88. <ol class="md-search-result__list" role="presentation"></ol>
  89. </div>
  90. </div>
  91. </div>
  92. </div>
  93. </div>
  94. </nav>
  95. </header>
  96. <div class="md-container" data-md-component="container">
  97. <main class="md-main" data-md-component="main">
  98. <div class="md-main__inner md-grid">
  99. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  100. <div class="md-sidebar__scrollwrap">
  101. <div class="md-sidebar__inner">
  102. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  103. <label class="md-nav__title" for="__drawer">
  104. <a href="." title="LLamaSharp Documentation" class="md-nav__button md-logo" aria-label="LLamaSharp Documentation" data-md-component="logo">
  105. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 9h5.5L13 3.5V9M6 2h8l6 6v12a2 2 0 0 1-2 2H6a2 2 0 0 1-2-2V4c0-1.11.89-2 2-2m9 16v-2H6v2h9m3-4v-2H6v2h12Z"/></svg>
  106. </a>
  107. LLamaSharp Documentation
  108. </label>
  109. <ul class="md-nav__list" data-md-scrollfix>
  110. <li class="md-nav__item md-nav__item--active">
  111. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  112. <label class="md-nav__link md-nav__link--active" for="__toc">
  113. Overview
  114. <span class="md-nav__icon md-icon"></span>
  115. </label>
  116. <a href="." class="md-nav__link md-nav__link--active">
  117. Overview
  118. </a>
  119. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  120. <label class="md-nav__title" for="__toc">
  121. <span class="md-nav__icon md-icon"></span>
  122. Table of contents
  123. </label>
  124. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  125. <li class="md-nav__item">
  126. <a href="#essential-insights-for-novice-learners" class="md-nav__link">
  127. Essential insights for novice learners
  128. </a>
  129. </li>
  130. <li class="md-nav__item">
  131. <a href="#integrations" class="md-nav__link">
  132. Integrations
  133. </a>
  134. </li>
  135. <li class="md-nav__item">
  136. <a href="#welcome-to-join-the-development" class="md-nav__link">
  137. Welcome to join the development!
  138. </a>
  139. </li>
  140. </ul>
  141. </nav>
  142. </li>
  143. <li class="md-nav__item">
  144. <a href="QuickStart/" class="md-nav__link">
  145. Quick Start
  146. </a>
  147. </li>
  148. <li class="md-nav__item">
  149. <a href="Architecture/" class="md-nav__link">
  150. Architecture
  151. </a>
  152. </li>
  153. <li class="md-nav__item">
  154. <a href="FAQ/" class="md-nav__link">
  155. FAQ
  156. </a>
  157. </li>
  158. <li class="md-nav__item">
  159. <a href="ContributingGuide/" class="md-nav__link">
  160. Contributing Guide
  161. </a>
  162. </li>
  163. <li class="md-nav__item md-nav__item--nested">
  164. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
  165. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  166. Tutorials
  167. <span class="md-nav__icon md-icon"></span>
  168. </label>
  169. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  170. <label class="md-nav__title" for="__nav_6">
  171. <span class="md-nav__icon md-icon"></span>
  172. Tutorials
  173. </label>
  174. <ul class="md-nav__list" data-md-scrollfix>
  175. <li class="md-nav__item">
  176. <a href="Tutorials/NativeLibraryConfig/" class="md-nav__link">
  177. Customize the native library loading
  178. </a>
  179. </li>
  180. <li class="md-nav__item">
  181. <a href="Tutorials/Executors/" class="md-nav__link">
  182. Use executors
  183. </a>
  184. </li>
  185. <li class="md-nav__item">
  186. <a href="Tutorials/ChatSession/" class="md-nav__link">
  187. Use ChatSession
  188. </a>
  189. </li>
  190. <li class="md-nav__item">
  191. <a href="Tutorials/UnderstandLLamaContext/" class="md-nav__link">
  192. Understand LLamaContext
  193. </a>
  194. </li>
  195. <li class="md-nav__item">
  196. <a href="Tutorials/GetEmbeddings/" class="md-nav__link">
  197. Get embeddings
  198. </a>
  199. </li>
  200. <li class="md-nav__item">
  201. <a href="Tutorials/Quantization/" class="md-nav__link">
  202. Quantize the model
  203. </a>
  204. </li>
  205. </ul>
  206. </nav>
  207. </li>
  208. <li class="md-nav__item md-nav__item--nested">
  209. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
  210. <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
  211. Integrations
  212. <span class="md-nav__icon md-icon"></span>
  213. </label>
  214. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
  215. <label class="md-nav__title" for="__nav_7">
  216. <span class="md-nav__icon md-icon"></span>
  217. Integrations
  218. </label>
  219. <ul class="md-nav__list" data-md-scrollfix>
  220. <li class="md-nav__item">
  221. <a href="Integrations/semantic-kernel/" class="md-nav__link">
  222. semantic-kernel integration
  223. </a>
  224. </li>
  225. <li class="md-nav__item">
  226. <a href="Integrations/kernel-memory/" class="md-nav__link">
  227. kernel-memory integration
  228. </a>
  229. </li>
  230. <li class="md-nav__item">
  231. <a href="Integrations/BotSharp.md" class="md-nav__link">
  232. BotSharp integration
  233. </a>
  234. </li>
  235. <li class="md-nav__item">
  236. <a href="Integrations/Langchain.md" class="md-nav__link">
  237. Langchain integration
  238. </a>
  239. </li>
  240. </ul>
  241. </nav>
  242. </li>
  243. <li class="md-nav__item md-nav__item--nested">
  244. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" >
  245. <label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
  246. Examples
  247. <span class="md-nav__icon md-icon"></span>
  248. </label>
  249. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
  250. <label class="md-nav__title" for="__nav_8">
  251. <span class="md-nav__icon md-icon"></span>
  252. Examples
  253. </label>
  254. <ul class="md-nav__list" data-md-scrollfix>
  255. <li class="md-nav__item">
  256. <a href="Examples/BatchedExecutorFork/" class="md-nav__link">
  257. Bacthed executor - multi-output to one input
  258. </a>
  259. </li>
  260. <li class="md-nav__item">
  261. <a href="Examples/BatchedExecutorGuidance/" class="md-nav__link">
  262. Batched executor - basic guidance
  263. </a>
  264. </li>
  265. <li class="md-nav__item">
  266. <a href="Examples/BatchedExecutorRewind/" class="md-nav__link">
  267. Batched executor - rewinding to an earlier state
  268. </a>
  269. </li>
  270. <li class="md-nav__item">
  271. <a href="Examples/ChatChineseGB2312/" class="md-nav__link">
  272. Chinese LLM - with GB2312 encoding
  273. </a>
  274. </li>
  275. <li class="md-nav__item">
  276. <a href="Examples/ChatSessionStripRoleName/" class="md-nav__link">
  277. ChatSession - stripping role names
  278. </a>
  279. </li>
  280. <li class="md-nav__item">
  281. <a href="Examples/ChatSessionWithHistory/" class="md-nav__link">
  282. ChatSession - with history
  283. </a>
  284. </li>
  285. <li class="md-nav__item">
  286. <a href="Examples/ChatSessionWithRestart/" class="md-nav__link">
  287. ChatSession - restarting
  288. </a>
  289. </li>
  290. <li class="md-nav__item">
  291. <a href="Examples/ChatSessionWithRoleName/" class="md-nav__link">
  292. ChatSession - Basic
  293. </a>
  294. </li>
  295. <li class="md-nav__item">
  296. <a href="Examples/CodingAssistant/" class="md-nav__link">
  297. Coding assistant
  298. </a>
  299. </li>
  300. <li class="md-nav__item">
  301. <a href="Examples/GetEmbeddings/" class="md-nav__link">
  302. Get embeddings
  303. </a>
  304. </li>
  305. <li class="md-nav__item">
  306. <a href="Examples/GrammarJsonResponse/" class="md-nav__link">
  307. Grammar - json response
  308. </a>
  309. </li>
  310. <li class="md-nav__item">
  311. <a href="Examples/InstructModeExecute/" class="md-nav__link">
  312. Instruct executor - basic
  313. </a>
  314. </li>
  315. <li class="md-nav__item">
  316. <a href="Examples/InteractiveModeExecute/" class="md-nav__link">
  317. Interactive executor - basic
  318. </a>
  319. </li>
  320. <li class="md-nav__item">
  321. <a href="Examples/KernelMemory/" class="md-nav__link">
  322. Kernel memory integration - basic
  323. </a>
  324. </li>
  325. <li class="md-nav__item">
  326. <a href="Examples/KernelMemorySaveAndLoad/" class="md-nav__link">
  327. Kernel-memory - save & load
  328. </a>
  329. </li>
  330. <li class="md-nav__item">
  331. <a href="Examples/LLavaInteractiveModeExecute/" class="md-nav__link">
  332. LLaVA - basic
  333. </a>
  334. </li>
  335. <li class="md-nav__item">
  336. <a href="Examples/LoadAndSaveSession/" class="md-nav__link">
  337. ChatSession - load & save
  338. </a>
  339. </li>
  340. <li class="md-nav__item">
  341. <a href="Examples/LoadAndSaveState/" class="md-nav__link">
  342. Executor - save/load state
  343. </a>
  344. </li>
  345. <li class="md-nav__item">
  346. <a href="Examples/QuantizeModel/" class="md-nav__link">
  347. Quantization
  348. </a>
  349. </li>
  350. <li class="md-nav__item">
  351. <a href="Examples/SemanticKernelChat/" class="md-nav__link">
  352. Semantic-kernel - chat
  353. </a>
  354. </li>
  355. <li class="md-nav__item">
  356. <a href="Examples/SemanticKernelMemory/" class="md-nav__link">
  357. Semantic-kernel - with kernel-memory
  358. </a>
  359. </li>
  360. <li class="md-nav__item">
  361. <a href="Examples/SemanticKernelPrompt/" class="md-nav__link">
  362. Semantic-kernel - basic
  363. </a>
  364. </li>
  365. <li class="md-nav__item">
  366. <a href="Examples/StatelessModeExecute/" class="md-nav__link">
  367. Stateless executor
  368. </a>
  369. </li>
  370. <li class="md-nav__item">
  371. <a href="Examples/TalkToYourself/" class="md-nav__link">
  372. Talk to yourself
  373. </a>
  374. </li>
  375. </ul>
  376. </nav>
  377. </li>
  378. <li class="md-nav__item md-nav__item--nested">
  379. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9" >
  380. <label class="md-nav__link" for="__nav_9" id="__nav_9_label" tabindex="0">
  381. API Reference
  382. <span class="md-nav__icon md-icon"></span>
  383. </label>
  384. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
  385. <label class="md-nav__title" for="__nav_9">
  386. <span class="md-nav__icon md-icon"></span>
  387. API Reference
  388. </label>
  389. <ul class="md-nav__list" data-md-scrollfix>
  390. <li class="md-nav__item">
  391. <a href="xmldocs/" class="md-nav__link">
  392. index
  393. </a>
  394. </li>
  395. <li class="md-nav__item">
  396. <a href="xmldocs/llama.abstractions.adaptercollection/" class="md-nav__link">
  397. llama.abstractions.adaptercollection
  398. </a>
  399. </li>
  400. <li class="md-nav__item">
  401. <a href="xmldocs/llama.abstractions.icontextparams/" class="md-nav__link">
  402. llama.abstractions.icontextparams
  403. </a>
  404. </li>
  405. <li class="md-nav__item">
  406. <a href="xmldocs/llama.abstractions.ihistorytransform/" class="md-nav__link">
  407. llama.abstractions.ihistorytransform
  408. </a>
  409. </li>
  410. <li class="md-nav__item">
  411. <a href="xmldocs/llama.abstractions.iinferenceparams/" class="md-nav__link">
  412. llama.abstractions.iinferenceparams
  413. </a>
  414. </li>
  415. <li class="md-nav__item">
  416. <a href="xmldocs/llama.abstractions.illamaexecutor/" class="md-nav__link">
  417. llama.abstractions.illamaexecutor
  418. </a>
  419. </li>
  420. <li class="md-nav__item">
  421. <a href="xmldocs/llama.abstractions.illamaparams/" class="md-nav__link">
  422. llama.abstractions.illamaparams
  423. </a>
  424. </li>
  425. <li class="md-nav__item">
  426. <a href="xmldocs/llama.abstractions.imodelparams/" class="md-nav__link">
  427. llama.abstractions.imodelparams
  428. </a>
  429. </li>
  430. <li class="md-nav__item">
  431. <a href="xmldocs/llama.abstractions.itextstreamtransform/" class="md-nav__link">
  432. llama.abstractions.itextstreamtransform
  433. </a>
  434. </li>
  435. <li class="md-nav__item">
  436. <a href="xmldocs/llama.abstractions.itexttransform/" class="md-nav__link">
  437. llama.abstractions.itexttransform
  438. </a>
  439. </li>
  440. <li class="md-nav__item">
  441. <a href="xmldocs/llama.abstractions.loraadapter/" class="md-nav__link">
  442. llama.abstractions.loraadapter
  443. </a>
  444. </li>
  445. <li class="md-nav__item">
  446. <a href="xmldocs/llama.abstractions.metadataoverride/" class="md-nav__link">
  447. llama.abstractions.metadataoverride
  448. </a>
  449. </li>
  450. <li class="md-nav__item">
  451. <a href="xmldocs/llama.abstractions.metadataoverrideconverter/" class="md-nav__link">
  452. llama.abstractions.metadataoverrideconverter
  453. </a>
  454. </li>
  455. <li class="md-nav__item">
  456. <a href="xmldocs/llama.abstractions.tensorsplitscollection/" class="md-nav__link">
  457. llama.abstractions.tensorsplitscollection
  458. </a>
  459. </li>
  460. <li class="md-nav__item">
  461. <a href="xmldocs/llama.abstractions.tensorsplitscollectionconverter/" class="md-nav__link">
  462. llama.abstractions.tensorsplitscollectionconverter
  463. </a>
  464. </li>
  465. <li class="md-nav__item">
  466. <a href="xmldocs/llama.antipromptprocessor/" class="md-nav__link">
  467. llama.antipromptprocessor
  468. </a>
  469. </li>
  470. <li class="md-nav__item">
  471. <a href="xmldocs/llama.batched.alreadypromptedconversationexception/" class="md-nav__link">
  472. llama.batched.alreadypromptedconversationexception
  473. </a>
  474. </li>
  475. <li class="md-nav__item">
  476. <a href="xmldocs/llama.batched.batchedexecutor/" class="md-nav__link">
  477. llama.batched.batchedexecutor
  478. </a>
  479. </li>
  480. <li class="md-nav__item">
  481. <a href="xmldocs/llama.batched.cannotforkwhilerequiresinferenceexception/" class="md-nav__link">
  482. llama.batched.cannotforkwhilerequiresinferenceexception
  483. </a>
  484. </li>
  485. <li class="md-nav__item">
  486. <a href="xmldocs/llama.batched.cannotmodifywhilerequiresinferenceexception/" class="md-nav__link">
  487. llama.batched.cannotmodifywhilerequiresinferenceexception
  488. </a>
  489. </li>
  490. <li class="md-nav__item">
  491. <a href="xmldocs/llama.batched.cannotsamplerequiresinferenceexception/" class="md-nav__link">
  492. llama.batched.cannotsamplerequiresinferenceexception
  493. </a>
  494. </li>
  495. <li class="md-nav__item">
  496. <a href="xmldocs/llama.batched.cannotsamplerequirespromptexception/" class="md-nav__link">
  497. llama.batched.cannotsamplerequirespromptexception
  498. </a>
  499. </li>
  500. <li class="md-nav__item">
  501. <a href="xmldocs/llama.batched.conversation/" class="md-nav__link">
  502. llama.batched.conversation
  503. </a>
  504. </li>
  505. <li class="md-nav__item">
  506. <a href="xmldocs/llama.batched.conversationextensions/" class="md-nav__link">
  507. llama.batched.conversationextensions
  508. </a>
  509. </li>
  510. <li class="md-nav__item">
  511. <a href="xmldocs/llama.batched.experimentalbatchedexecutorexception/" class="md-nav__link">
  512. llama.batched.experimentalbatchedexecutorexception
  513. </a>
  514. </li>
  515. <li class="md-nav__item">
  516. <a href="xmldocs/llama.chatsession-1/" class="md-nav__link">
  517. llama.chatsession-1
  518. </a>
  519. </li>
  520. <li class="md-nav__item">
  521. <a href="xmldocs/llama.chatsession/" class="md-nav__link">
  522. llama.chatsession
  523. </a>
  524. </li>
  525. <li class="md-nav__item">
  526. <a href="xmldocs/llama.common.authorrole/" class="md-nav__link">
  527. llama.common.authorrole
  528. </a>
  529. </li>
  530. <li class="md-nav__item">
  531. <a href="xmldocs/llama.common.chathistory/" class="md-nav__link">
  532. llama.common.chathistory
  533. </a>
  534. </li>
  535. <li class="md-nav__item">
  536. <a href="xmldocs/llama.common.fixedsizequeue-1/" class="md-nav__link">
  537. llama.common.fixedsizequeue-1
  538. </a>
  539. </li>
  540. <li class="md-nav__item">
  541. <a href="xmldocs/llama.common.inferenceparams/" class="md-nav__link">
  542. llama.common.inferenceparams
  543. </a>
  544. </li>
  545. <li class="md-nav__item">
  546. <a href="xmldocs/llama.common.mirostattype/" class="md-nav__link">
  547. llama.common.mirostattype
  548. </a>
  549. </li>
  550. <li class="md-nav__item">
  551. <a href="xmldocs/llama.common.modelparams/" class="md-nav__link">
  552. llama.common.modelparams
  553. </a>
  554. </li>
  555. <li class="md-nav__item">
  556. <a href="xmldocs/llama.exceptions.grammarexpectedname/" class="md-nav__link">
  557. llama.exceptions.grammarexpectedname
  558. </a>
  559. </li>
  560. <li class="md-nav__item">
  561. <a href="xmldocs/llama.exceptions.grammarexpectednext/" class="md-nav__link">
  562. llama.exceptions.grammarexpectednext
  563. </a>
  564. </li>
  565. <li class="md-nav__item">
  566. <a href="xmldocs/llama.exceptions.grammarexpectedprevious/" class="md-nav__link">
  567. llama.exceptions.grammarexpectedprevious
  568. </a>
  569. </li>
  570. <li class="md-nav__item">
  571. <a href="xmldocs/llama.exceptions.grammarformatexception/" class="md-nav__link">
  572. llama.exceptions.grammarformatexception
  573. </a>
  574. </li>
  575. <li class="md-nav__item">
  576. <a href="xmldocs/llama.exceptions.grammarunexpectedcharaltelement/" class="md-nav__link">
  577. llama.exceptions.grammarunexpectedcharaltelement
  578. </a>
  579. </li>
  580. <li class="md-nav__item">
  581. <a href="xmldocs/llama.exceptions.grammarunexpectedcharrngelement/" class="md-nav__link">
  582. llama.exceptions.grammarunexpectedcharrngelement
  583. </a>
  584. </li>
  585. <li class="md-nav__item">
  586. <a href="xmldocs/llama.exceptions.grammarunexpectedendelement/" class="md-nav__link">
  587. llama.exceptions.grammarunexpectedendelement
  588. </a>
  589. </li>
  590. <li class="md-nav__item">
  591. <a href="xmldocs/llama.exceptions.grammarunexpectedendofinput/" class="md-nav__link">
  592. llama.exceptions.grammarunexpectedendofinput
  593. </a>
  594. </li>
  595. <li class="md-nav__item">
  596. <a href="xmldocs/llama.exceptions.grammarunexpectedhexcharscount/" class="md-nav__link">
  597. llama.exceptions.grammarunexpectedhexcharscount
  598. </a>
  599. </li>
  600. <li class="md-nav__item">
  601. <a href="xmldocs/llama.exceptions.grammarunknownescapecharacter/" class="md-nav__link">
  602. llama.exceptions.grammarunknownescapecharacter
  603. </a>
  604. </li>
  605. <li class="md-nav__item">
  606. <a href="xmldocs/llama.exceptions.llamadecodeerror/" class="md-nav__link">
  607. llama.exceptions.llamadecodeerror
  608. </a>
  609. </li>
  610. <li class="md-nav__item">
  611. <a href="xmldocs/llama.exceptions.loadweightsfailedexception/" class="md-nav__link">
  612. llama.exceptions.loadweightsfailedexception
  613. </a>
  614. </li>
  615. <li class="md-nav__item">
  616. <a href="xmldocs/llama.exceptions.runtimeerror/" class="md-nav__link">
  617. llama.exceptions.runtimeerror
  618. </a>
  619. </li>
  620. <li class="md-nav__item">
  621. <a href="xmldocs/llama.extensions.icontextparamsextensions/" class="md-nav__link">
  622. llama.extensions.icontextparamsextensions
  623. </a>
  624. </li>
  625. <li class="md-nav__item">
  626. <a href="xmldocs/llama.extensions.imodelparamsextensions/" class="md-nav__link">
  627. llama.extensions.imodelparamsextensions
  628. </a>
  629. </li>
  630. <li class="md-nav__item">
  631. <a href="xmldocs/llama.grammars.grammar/" class="md-nav__link">
  632. llama.grammars.grammar
  633. </a>
  634. </li>
  635. <li class="md-nav__item">
  636. <a href="xmldocs/llama.grammars.grammarrule/" class="md-nav__link">
  637. llama.grammars.grammarrule
  638. </a>
  639. </li>
  640. <li class="md-nav__item">
  641. <a href="xmldocs/llama.ichatmodel/" class="md-nav__link">
  642. llama.ichatmodel
  643. </a>
  644. </li>
  645. <li class="md-nav__item">
  646. <a href="xmldocs/llama.llamacache/" class="md-nav__link">
  647. llama.llamacache
  648. </a>
  649. </li>
  650. <li class="md-nav__item">
  651. <a href="xmldocs/llama.llamaembedder/" class="md-nav__link">
  652. llama.llamaembedder
  653. </a>
  654. </li>
  655. <li class="md-nav__item">
  656. <a href="xmldocs/llama.llamamodel/" class="md-nav__link">
  657. llama.llamamodel
  658. </a>
  659. </li>
  660. <li class="md-nav__item">
  661. <a href="xmldocs/llama.llamamodelv1/" class="md-nav__link">
  662. llama.llamamodelv1
  663. </a>
  664. </li>
  665. <li class="md-nav__item">
  666. <a href="xmldocs/llama.llamaparams/" class="md-nav__link">
  667. llama.llamaparams
  668. </a>
  669. </li>
  670. <li class="md-nav__item">
  671. <a href="xmldocs/llama.llamaquantizer/" class="md-nav__link">
  672. llama.llamaquantizer
  673. </a>
  674. </li>
  675. <li class="md-nav__item">
  676. <a href="xmldocs/llama.llamastate/" class="md-nav__link">
  677. llama.llamastate
  678. </a>
  679. </li>
  680. <li class="md-nav__item">
  681. <a href="xmldocs/llama.llamatransforms/" class="md-nav__link">
  682. llama.llamatransforms
  683. </a>
  684. </li>
  685. <li class="md-nav__item">
  686. <a href="xmldocs/llama.llavaweights/" class="md-nav__link">
  687. llama.llavaweights
  688. </a>
  689. </li>
  690. <li class="md-nav__item">
  691. <a href="xmldocs/llama.native.decoderesult/" class="md-nav__link">
  692. llama.native.decoderesult
  693. </a>
  694. </li>
  695. <li class="md-nav__item">
  696. <a href="xmldocs/llama.native.ggmltype/" class="md-nav__link">
  697. llama.native.ggmltype
  698. </a>
  699. </li>
  700. <li class="md-nav__item">
  701. <a href="xmldocs/llama.native.gpusplitmode/" class="md-nav__link">
  702. llama.native.gpusplitmode
  703. </a>
  704. </li>
  705. <li class="md-nav__item">
  706. <a href="xmldocs/llama.native.llamabatch/" class="md-nav__link">
  707. llama.native.llamabatch
  708. </a>
  709. </li>
  710. <li class="md-nav__item">
  711. <a href="xmldocs/llama.native.llamabeamsstate/" class="md-nav__link">
  712. llama.native.llamabeamsstate
  713. </a>
  714. </li>
  715. <li class="md-nav__item">
  716. <a href="xmldocs/llama.native.llamabeamview/" class="md-nav__link">
  717. llama.native.llamabeamview
  718. </a>
  719. </li>
  720. <li class="md-nav__item">
  721. <a href="xmldocs/llama.native.llamachatmessage/" class="md-nav__link">
  722. llama.native.llamachatmessage
  723. </a>
  724. </li>
  725. <li class="md-nav__item">
  726. <a href="xmldocs/llama.native.llamacontextparams/" class="md-nav__link">
  727. llama.native.llamacontextparams
  728. </a>
  729. </li>
  730. <li class="md-nav__item">
  731. <a href="xmldocs/llama.native.llamaftype/" class="md-nav__link">
  732. llama.native.llamaftype
  733. </a>
  734. </li>
  735. <li class="md-nav__item">
  736. <a href="xmldocs/llama.native.llamagrammarelement/" class="md-nav__link">
  737. llama.native.llamagrammarelement
  738. </a>
  739. </li>
  740. <li class="md-nav__item">
  741. <a href="xmldocs/llama.native.llamagrammarelementtype/" class="md-nav__link">
  742. llama.native.llamagrammarelementtype
  743. </a>
  744. </li>
  745. <li class="md-nav__item">
  746. <a href="xmldocs/llama.native.llamakvcacheview/" class="md-nav__link">
  747. llama.native.llamakvcacheview
  748. </a>
  749. </li>
  750. <li class="md-nav__item">
  751. <a href="xmldocs/llama.native.llamakvcacheviewcell/" class="md-nav__link">
  752. llama.native.llamakvcacheviewcell
  753. </a>
  754. </li>
  755. <li class="md-nav__item">
  756. <a href="xmldocs/llama.native.llamakvcacheviewsafehandle/" class="md-nav__link">
  757. llama.native.llamakvcacheviewsafehandle
  758. </a>
  759. </li>
  760. <li class="md-nav__item">
  761. <a href="xmldocs/llama.native.llamaloglevel/" class="md-nav__link">
  762. llama.native.llamaloglevel
  763. </a>
  764. </li>
  765. <li class="md-nav__item">
  766. <a href="xmldocs/llama.native.llamamodelkvoverridetype/" class="md-nav__link">
  767. llama.native.llamamodelkvoverridetype
  768. </a>
  769. </li>
  770. <li class="md-nav__item">
  771. <a href="xmldocs/llama.native.llamamodelmetadataoverride/" class="md-nav__link">
  772. llama.native.llamamodelmetadataoverride
  773. </a>
  774. </li>
  775. <li class="md-nav__item">
  776. <a href="xmldocs/llama.native.llamamodelparams/" class="md-nav__link">
  777. llama.native.llamamodelparams
  778. </a>
  779. </li>
  780. <li class="md-nav__item">
  781. <a href="xmldocs/llama.native.llamamodelquantizeparams/" class="md-nav__link">
  782. llama.native.llamamodelquantizeparams
  783. </a>
  784. </li>
  785. <li class="md-nav__item">
  786. <a href="xmldocs/llama.native.llamanativebatch/" class="md-nav__link">
  787. llama.native.llamanativebatch
  788. </a>
  789. </li>
  790. <li class="md-nav__item">
  791. <a href="xmldocs/llama.native.llamapoolingtype/" class="md-nav__link">
  792. llama.native.llamapoolingtype
  793. </a>
  794. </li>
  795. <li class="md-nav__item">
  796. <a href="xmldocs/llama.native.llamapos/" class="md-nav__link">
  797. llama.native.llamapos
  798. </a>
  799. </li>
  800. <li class="md-nav__item">
  801. <a href="xmldocs/llama.native.llamaropetype/" class="md-nav__link">
  802. llama.native.llamaropetype
  803. </a>
  804. </li>
  805. <li class="md-nav__item">
  806. <a href="xmldocs/llama.native.llamaseqid/" class="md-nav__link">
  807. llama.native.llamaseqid
  808. </a>
  809. </li>
  810. <li class="md-nav__item">
  811. <a href="xmldocs/llama.native.llamatoken/" class="md-nav__link">
  812. llama.native.llamatoken
  813. </a>
  814. </li>
  815. <li class="md-nav__item">
  816. <a href="xmldocs/llama.native.llamatokendata/" class="md-nav__link">
  817. llama.native.llamatokendata
  818. </a>
  819. </li>
  820. <li class="md-nav__item">
  821. <a href="xmldocs/llama.native.llamatokendataarray/" class="md-nav__link">
  822. llama.native.llamatokendataarray
  823. </a>
  824. </li>
  825. <li class="md-nav__item">
  826. <a href="xmldocs/llama.native.llamatokendataarraynative/" class="md-nav__link">
  827. llama.native.llamatokendataarraynative
  828. </a>
  829. </li>
  830. <li class="md-nav__item">
  831. <a href="xmldocs/llama.native.llamatokentype/" class="md-nav__link">
  832. llama.native.llamatokentype
  833. </a>
  834. </li>
  835. <li class="md-nav__item">
  836. <a href="xmldocs/llama.native.llamavocabtype/" class="md-nav__link">
  837. llama.native.llamavocabtype
  838. </a>
  839. </li>
  840. <li class="md-nav__item">
  841. <a href="xmldocs/llama.native.llavaimageembed/" class="md-nav__link">
  842. llama.native.llavaimageembed
  843. </a>
  844. </li>
  845. <li class="md-nav__item">
  846. <a href="xmldocs/llama.native.nativeapi/" class="md-nav__link">
  847. llama.native.nativeapi
  848. </a>
  849. </li>
  850. <li class="md-nav__item">
  851. <a href="xmldocs/llama.native.nativelibraryconfig/" class="md-nav__link">
  852. llama.native.nativelibraryconfig
  853. </a>
  854. </li>
  855. <li class="md-nav__item">
  856. <a href="xmldocs/llama.native.ropescalingtype/" class="md-nav__link">
  857. llama.native.ropescalingtype
  858. </a>
  859. </li>
  860. <li class="md-nav__item">
  861. <a href="xmldocs/llama.native.safellamacontexthandle/" class="md-nav__link">
  862. llama.native.safellamacontexthandle
  863. </a>
  864. </li>
  865. <li class="md-nav__item">
  866. <a href="xmldocs/llama.native.safellamagrammarhandle/" class="md-nav__link">
  867. llama.native.safellamagrammarhandle
  868. </a>
  869. </li>
  870. <li class="md-nav__item">
  871. <a href="xmldocs/llama.native.safellamahandlebase/" class="md-nav__link">
  872. llama.native.safellamahandlebase
  873. </a>
  874. </li>
  875. <li class="md-nav__item">
  876. <a href="xmldocs/llama.native.safellamamodelhandle/" class="md-nav__link">
  877. llama.native.safellamamodelhandle
  878. </a>
  879. </li>
  880. <li class="md-nav__item">
  881. <a href="xmldocs/llama.native.safellavaimageembedhandle/" class="md-nav__link">
  882. llama.native.safellavaimageembedhandle
  883. </a>
  884. </li>
  885. <li class="md-nav__item">
  886. <a href="xmldocs/llama.native.safellavamodelhandle/" class="md-nav__link">
  887. llama.native.safellavamodelhandle
  888. </a>
  889. </li>
  890. <li class="md-nav__item">
  891. <a href="xmldocs/llama.quantizer/" class="md-nav__link">
  892. llama.quantizer
  893. </a>
  894. </li>
  895. <li class="md-nav__item">
  896. <a href="xmldocs/llama.sampling.basesamplingpipeline/" class="md-nav__link">
  897. llama.sampling.basesamplingpipeline
  898. </a>
  899. </li>
  900. <li class="md-nav__item">
  901. <a href="xmldocs/llama.sampling.defaultsamplingpipeline/" class="md-nav__link">
  902. llama.sampling.defaultsamplingpipeline
  903. </a>
  904. </li>
  905. <li class="md-nav__item">
  906. <a href="xmldocs/llama.sampling.greedysamplingpipeline/" class="md-nav__link">
  907. llama.sampling.greedysamplingpipeline
  908. </a>
  909. </li>
  910. <li class="md-nav__item">
  911. <a href="xmldocs/llama.sampling.isamplingpipeline/" class="md-nav__link">
  912. llama.sampling.isamplingpipeline
  913. </a>
  914. </li>
  915. <li class="md-nav__item">
  916. <a href="xmldocs/llama.sampling.isamplingpipelineextensions/" class="md-nav__link">
  917. llama.sampling.isamplingpipelineextensions
  918. </a>
  919. </li>
  920. <li class="md-nav__item">
  921. <a href="xmldocs/llama.sampling.mirostate2samplingpipeline/" class="md-nav__link">
  922. llama.sampling.mirostate2samplingpipeline
  923. </a>
  924. </li>
  925. <li class="md-nav__item">
  926. <a href="xmldocs/llama.sampling.mirostatesamplingpipeline/" class="md-nav__link">
  927. llama.sampling.mirostatesamplingpipeline
  928. </a>
  929. </li>
  930. <li class="md-nav__item">
  931. <a href="xmldocs/llama.sessionstate/" class="md-nav__link">
  932. llama.sessionstate
  933. </a>
  934. </li>
  935. <li class="md-nav__item">
  936. <a href="xmldocs/llama.streamingtokendecoder/" class="md-nav__link">
  937. llama.streamingtokendecoder
  938. </a>
  939. </li>
  940. <li class="md-nav__item">
  941. <a href="xmldocs/llama.types.chatcompletion/" class="md-nav__link">
  942. llama.types.chatcompletion
  943. </a>
  944. </li>
  945. <li class="md-nav__item">
  946. <a href="xmldocs/llama.types.chatcompletionchoice/" class="md-nav__link">
  947. llama.types.chatcompletionchoice
  948. </a>
  949. </li>
  950. <li class="md-nav__item">
  951. <a href="xmldocs/llama.types.chatcompletionchunk/" class="md-nav__link">
  952. llama.types.chatcompletionchunk
  953. </a>
  954. </li>
  955. <li class="md-nav__item">
  956. <a href="xmldocs/llama.types.chatcompletionchunkchoice/" class="md-nav__link">
  957. llama.types.chatcompletionchunkchoice
  958. </a>
  959. </li>
  960. <li class="md-nav__item">
  961. <a href="xmldocs/llama.types.chatcompletionchunkdelta/" class="md-nav__link">
  962. llama.types.chatcompletionchunkdelta
  963. </a>
  964. </li>
  965. <li class="md-nav__item">
  966. <a href="xmldocs/llama.types.chatcompletionmessage/" class="md-nav__link">
  967. llama.types.chatcompletionmessage
  968. </a>
  969. </li>
  970. <li class="md-nav__item">
  971. <a href="xmldocs/llama.types.chatmessagerecord/" class="md-nav__link">
  972. llama.types.chatmessagerecord
  973. </a>
  974. </li>
  975. <li class="md-nav__item">
  976. <a href="xmldocs/llama.types.chatrole/" class="md-nav__link">
  977. llama.types.chatrole
  978. </a>
  979. </li>
  980. <li class="md-nav__item">
  981. <a href="xmldocs/llama.types.completion/" class="md-nav__link">
  982. llama.types.completion
  983. </a>
  984. </li>
  985. <li class="md-nav__item">
  986. <a href="xmldocs/llama.types.completionchoice/" class="md-nav__link">
  987. llama.types.completionchoice
  988. </a>
  989. </li>
  990. <li class="md-nav__item">
  991. <a href="xmldocs/llama.types.completionchunk/" class="md-nav__link">
  992. llama.types.completionchunk
  993. </a>
  994. </li>
  995. <li class="md-nav__item">
  996. <a href="xmldocs/llama.types.completionlogprobs/" class="md-nav__link">
  997. llama.types.completionlogprobs
  998. </a>
  999. </li>
  1000. <li class="md-nav__item">
  1001. <a href="xmldocs/llama.types.completionusage/" class="md-nav__link">
  1002. llama.types.completionusage
  1003. </a>
  1004. </li>
  1005. <li class="md-nav__item">
  1006. <a href="xmldocs/llama.types.embedding/" class="md-nav__link">
  1007. llama.types.embedding
  1008. </a>
  1009. </li>
  1010. <li class="md-nav__item">
  1011. <a href="xmldocs/llama.types.embeddingdata/" class="md-nav__link">
  1012. llama.types.embeddingdata
  1013. </a>
  1014. </li>
  1015. <li class="md-nav__item">
  1016. <a href="xmldocs/llama.types.embeddingusage/" class="md-nav__link">
  1017. llama.types.embeddingusage
  1018. </a>
  1019. </li>
  1020. <li class="md-nav__item">
  1021. <a href="xmldocs/logger/" class="md-nav__link">
  1022. logger
  1023. </a>
  1024. </li>
  1025. </ul>
  1026. </nav>
  1027. </li>
  1028. </ul>
  1029. </nav>
  1030. </div>
  1031. </div>
  1032. </div>
  1033. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1034. <div class="md-sidebar__scrollwrap">
  1035. <div class="md-sidebar__inner">
  1036. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1037. <label class="md-nav__title" for="__toc">
  1038. <span class="md-nav__icon md-icon"></span>
  1039. Table of contents
  1040. </label>
  1041. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1042. <li class="md-nav__item">
  1043. <a href="#essential-insights-for-novice-learners" class="md-nav__link">
  1044. Essential insights for novice learners
  1045. </a>
  1046. </li>
  1047. <li class="md-nav__item">
  1048. <a href="#integrations" class="md-nav__link">
  1049. Integrations
  1050. </a>
  1051. </li>
  1052. <li class="md-nav__item">
  1053. <a href="#welcome-to-join-the-development" class="md-nav__link">
  1054. Welcome to join the development!
  1055. </a>
  1056. </li>
  1057. </ul>
  1058. </nav>
  1059. </div>
  1060. </div>
  1061. </div>
  1062. <div class="md-content" data-md-component="content">
  1063. <article class="md-content__inner md-typeset">
  1064. <h1 id="overview">Overview<a class="headerlink" href="#overview" title="Permanent link"></a></h1>
  1065. <p><img alt="logo" src="media/LLamaSharpLogo.png" /></p>
  1066. <p>LLamaSharp is a cross-platform library to run 🦙LLaMA/LLaVA model (and others) in local device. Based on <a href="https://github.com/ggerganov/llama.cpp">llama.cpp</a>, inference with LLamaSharp is efficient on both CPU and GPU. With the higher-level APIs and RAG support, it's convenient to deploy LLM (Large Language Model) in your application with LLamaSharp.</p>
  1067. <h2 id="essential-insights-for-novice-learners">Essential insights for novice learners<a class="headerlink" href="#essential-insights-for-novice-learners" title="Permanent link"></a></h2>
  1068. <p>If you are new to LLM, here're some tips for you to help you to get start with <code>LLamaSharp</code>. If you are experienced in this field, we'd still recommend you to take a few minutes to read it because some things perform differently compared to cpp/python.</p>
  1069. <ol>
  1070. <li>The main ability of LLamaSharp is to provide an efficient way to run inference of LLM on your device (and fine-tune model in the future). The model weights, however, need to be downloaded from other resources such as <a href="https://huggingface.co">huggingface</a>.</li>
  1071. <li>To gain high performance, LLamaSharp interacts with a native library compiled from c++, which is called <code>backend</code>. We provide backend packages for Windows, Linux and MAC with CPU, Cuda, Metal and OpenCL. You <strong>don't</strong> need to handle anything about c++ but just install the backend packages. If no published backend match your device, please open an issue to let us know. If compiling c++ code is not difficult for you, you could also follow <a href="">this guide</a> to compile a backend and run LLamaSharp with it.</li>
  1072. <li><code>LLaMA</code> originally refers to the weights released by Meta (Facebook Research). After that, many models are fine-tuned based on it, such as <code>Vicuna</code>, <code>GPT4All</code>, and <code>Pyglion</code>. There are two popular file format of these model now, which are PyTorch format (.pth) and Huggingface format (.bin). LLamaSharp uses <code>GGUF</code> format file, which could be converted from these two formats. There are two options for you to get GGUF format file. a) Search model name + 'gguf' in <a href="https://huggingface.co">Huggingface</a>, you will find lots of model files that have already been converted to GGUF format. Please take care of the publishing time of them because some old ones could only work with old version of LLamaSharp. b) Convert PyTorch or Huggingface format to GGUF format yourself. Please follow the instructions of <a href="https://github.com/ggerganov/llama.cpp?tab=readme-ov-file#prepare-and-quantize">this part of llama.cpp readme</a> to convert them with the python scripts.</li>
  1073. <li>LLamaSharp supports multi-modal, which means that the model could take both text and image as input. Note that there are two model files requied for using multi-modal (LLaVA), which are main model and mm-proj model. Here is a huggingface repo which shows that: <a href="https://huggingface.co/ShadowBeast/llava-v1.6-mistral-7b-Q5_K_S-GGUF/tree/main">link</a>.</li>
  1074. </ol>
  1075. <h2 id="integrations">Integrations<a class="headerlink" href="#integrations" title="Permanent link"></a></h2>
  1076. <p>There are integarions for the following libraries, which help to expand the application of LLamaSharp. Integrations for semantic-kernel and kernel-memory are developed in LLamaSharp repository, while others are developed in their own repositories.</p>
  1077. <ul>
  1078. <li><a href="https://github.com/microsoft/semantic-kernel">semantic-kernel</a>: an SDK that integrates LLM like OpenAI, Azure OpenAI, and Hugging Face.</li>
  1079. <li><a href="https://github.com/microsoft/kernel-memory">kernel-memory</a>: a multi-modal AI Service specialized in the efficient indexing of datasets through custom continuous data hybrid pipelines, with support for RAG (<a href="https://en.wikipedia.org/wiki/Prompt_engineering#Retrieval-augmented_generation">Retrieval Augmented Generation</a>), synthetic memory, prompt engineering, and custom semantic memory processing.</li>
  1080. <li><a href="https://github.com/SciSharp/BotSharp">BotSharp</a>: an open source machine learning framework for AI Bot platform builder.</li>
  1081. <li><a href="https://github.com/tryAGI/LangChain">Langchain</a>: a framework for developing applications powered by language models.</li>
  1082. </ul>
  1083. <p><img alt="LLamaShrp-Integrations" src="media/LLamaSharp-Integrations.png" /></p>
  1084. <h2 id="welcome-to-join-the-development">Welcome to join the development!<a class="headerlink" href="#welcome-to-join-the-development" title="Permanent link"></a></h2>
  1085. <p>Community effort is always one of the most important things in open-source projects. Any contribution in any way is welcomed here. For example, the following things mean a lot for LLamaSharp:</p>
  1086. <ol>
  1087. <li>Open an issue when you find something wrong.</li>
  1088. <li>Open an PR if you've fixed something. Even if just correcting a typo, it also makes great sense.</li>
  1089. <li>Help to optimize the documentation. </li>
  1090. <li>Write an example or blog about how to integrate LLamaSharp with your APPs.</li>
  1091. <li>Ask for a missing feature and discuss with us.</li>
  1092. </ol>
  1093. <p>If you'd like to get deeply involved in development, please touch us in discord channel or send email to <code>AsakusaRinne@gmail.com</code>. 🤗</p>
  1094. </article>
  1095. </div>
  1096. </div>
  1097. </main>
  1098. <footer class="md-footer">
  1099. <div class="md-footer-meta md-typeset">
  1100. <div class="md-footer-meta__inner md-grid">
  1101. <div class="md-copyright">
  1102. Made with
  1103. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1104. Material for MkDocs
  1105. </a>
  1106. </div>
  1107. </div>
  1108. </div>
  1109. </footer>
  1110. </div>
  1111. <div class="md-dialog" data-md-component="dialog">
  1112. <div class="md-dialog__inner md-typeset"></div>
  1113. </div>
  1114. <script id="__config" type="application/json">{"base": ".", "features": ["content.action.edit", "navigation.instant"], "search": "assets/javascripts/workers/search.74e28a9f.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>
  1115. <script src="assets/javascripts/bundle.220ee61c.min.js"></script>
  1116. </body>
  1117. </html>

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

Contributors (1)