Skip to content

Commit

Permalink
docs(api): build
Browse files Browse the repository at this point in the history
  • Loading branch information
jhen0409 committed Nov 17, 2024
1 parent 8e54cbb commit 7e394fa
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 42 deletions.
22 changes: 11 additions & 11 deletions docs/API/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ llama.rn

#### Defined in

[index.ts:58](https://github.com/mybigday/llama.rn/blob/68acf1a/src/index.ts#L58)
[index.ts:63](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/index.ts#L63)

___

Expand All @@ -55,17 +55,17 @@ ___

#### Defined in

[index.ts:49](https://github.com/mybigday/llama.rn/blob/68acf1a/src/index.ts#L49)
[index.ts:54](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/index.ts#L54)

___

### ContextParams

Ƭ **ContextParams**: `Omit`<`NativeContextParams`, ``"pooling_type"``\> & { `pooling_type?`: ``"none"`` \| ``"mean"`` \| ``"cls"`` \| ``"last"`` \| ``"rank"`` }
Ƭ **ContextParams**: `Omit`<`NativeContextParams`, ``"cache_type_k"`` \| ``"cache_type_v"`` \| ``"pooling_type"``\> & { `cache_type_k?`: ``"f16"`` \| ``"f32"`` \| ``"q8_0"`` \| ``"q4_0"`` \| ``"q4_1"`` \| ``"iq4_nl"`` \| ``"q5_0"`` \| ``"q5_1"`` ; `cache_type_v?`: ``"f16"`` \| ``"f32"`` \| ``"q8_0"`` \| ``"q4_0"`` \| ``"q4_1"`` \| ``"iq4_nl"`` \| ``"q5_0"`` \| ``"q5_1"`` ; `pooling_type?`: ``"none"`` \| ``"mean"`` \| ``"cls"`` \| ``"last"`` \| ``"rank"`` }

#### Defined in

[index.ts:43](https://github.com/mybigday/llama.rn/blob/68acf1a/src/index.ts#L43)
[index.ts:43](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/index.ts#L43)

___

Expand All @@ -75,7 +75,7 @@ ___

#### Defined in

[index.ts:47](https://github.com/mybigday/llama.rn/blob/68acf1a/src/index.ts#L47)
[index.ts:52](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/index.ts#L52)

___

Expand All @@ -92,7 +92,7 @@ ___

#### Defined in

[index.ts:33](https://github.com/mybigday/llama.rn/blob/68acf1a/src/index.ts#L33)
[index.ts:33](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/index.ts#L33)

## Functions

Expand All @@ -116,7 +116,7 @@ ___

#### Defined in

[grammar.ts:824](https://github.com/mybigday/llama.rn/blob/68acf1a/src/grammar.ts#L824)
[grammar.ts:824](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/grammar.ts#L824)

___

Expand All @@ -137,7 +137,7 @@ ___

#### Defined in

[index.ts:225](https://github.com/mybigday/llama.rn/blob/68acf1a/src/index.ts#L225)
[index.ts:230](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/index.ts#L230)

___

Expand All @@ -157,7 +157,7 @@ ___

#### Defined in

[index.ts:210](https://github.com/mybigday/llama.rn/blob/68acf1a/src/index.ts#L210)
[index.ts:215](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/index.ts#L215)

___

Expand All @@ -171,7 +171,7 @@ ___

#### Defined in

[index.ts:275](https://github.com/mybigday/llama.rn/blob/68acf1a/src/index.ts#L275)
[index.ts:280](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/index.ts#L280)

___

Expand All @@ -191,4 +191,4 @@ ___

#### Defined in

[index.ts:196](https://github.com/mybigday/llama.rn/blob/68acf1a/src/index.ts#L196)
[index.ts:201](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/index.ts#L201)
30 changes: 15 additions & 15 deletions docs/API/classes/LlamaContext.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@

#### Defined in

[index.ts:79](https://github.com/mybigday/llama.rn/blob/68acf1a/src/index.ts#L79)
[index.ts:84](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/index.ts#L84)

## Properties

Expand All @@ -52,7 +52,7 @@

#### Defined in

[index.ts:71](https://github.com/mybigday/llama.rn/blob/68acf1a/src/index.ts#L71)
[index.ts:76](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/index.ts#L76)

___

Expand All @@ -62,7 +62,7 @@ ___

#### Defined in

[index.ts:69](https://github.com/mybigday/llama.rn/blob/68acf1a/src/index.ts#L69)
[index.ts:74](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/index.ts#L74)

___

Expand All @@ -78,7 +78,7 @@ ___

#### Defined in

[index.ts:75](https://github.com/mybigday/llama.rn/blob/68acf1a/src/index.ts#L75)
[index.ts:80](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/index.ts#L80)

___

Expand All @@ -88,7 +88,7 @@ ___

#### Defined in

[index.ts:73](https://github.com/mybigday/llama.rn/blob/68acf1a/src/index.ts#L73)
[index.ts:78](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/index.ts#L78)

## Methods

Expand All @@ -111,7 +111,7 @@ ___

#### Defined in

[index.ts:171](https://github.com/mybigday/llama.rn/blob/68acf1a/src/index.ts#L171)
[index.ts:176](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/index.ts#L176)

___

Expand All @@ -132,7 +132,7 @@ ___

#### Defined in

[index.ts:115](https://github.com/mybigday/llama.rn/blob/68acf1a/src/index.ts#L115)
[index.ts:120](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/index.ts#L120)

___

Expand All @@ -152,7 +152,7 @@ ___

#### Defined in

[index.ts:160](https://github.com/mybigday/llama.rn/blob/68acf1a/src/index.ts#L160)
[index.ts:165](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/index.ts#L165)

___

Expand All @@ -173,7 +173,7 @@ ___

#### Defined in

[index.ts:164](https://github.com/mybigday/llama.rn/blob/68acf1a/src/index.ts#L164)
[index.ts:169](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/index.ts#L169)

___

Expand All @@ -194,7 +194,7 @@ ___

#### Defined in

[index.ts:105](https://github.com/mybigday/llama.rn/blob/68acf1a/src/index.ts#L105)
[index.ts:110](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/index.ts#L110)

___

Expand All @@ -216,7 +216,7 @@ Load cached prompt & completion state from a file.

#### Defined in

[index.ts:89](https://github.com/mybigday/llama.rn/blob/68acf1a/src/index.ts#L89)
[index.ts:94](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/index.ts#L94)

___

Expand All @@ -230,7 +230,7 @@ ___

#### Defined in

[index.ts:191](https://github.com/mybigday/llama.rn/blob/68acf1a/src/index.ts#L191)
[index.ts:196](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/index.ts#L196)

___

Expand All @@ -254,7 +254,7 @@ Save current cached prompt & completion state to a file.

#### Defined in

[index.ts:98](https://github.com/mybigday/llama.rn/blob/68acf1a/src/index.ts#L98)
[index.ts:103](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/index.ts#L103)

___

Expand All @@ -268,7 +268,7 @@ ___

#### Defined in

[index.ts:152](https://github.com/mybigday/llama.rn/blob/68acf1a/src/index.ts#L152)
[index.ts:157](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/index.ts#L157)

___

Expand All @@ -288,4 +288,4 @@ ___

#### Defined in

[index.ts:156](https://github.com/mybigday/llama.rn/blob/68acf1a/src/index.ts#L156)
[index.ts:161](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/index.ts#L161)
32 changes: 16 additions & 16 deletions docs/API/classes/SchemaGrammarConverter.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@

#### Defined in

[grammar.ts:211](https://github.com/mybigday/llama.rn/blob/68acf1a/src/grammar.ts#L211)
[grammar.ts:211](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/grammar.ts#L211)

## Properties

Expand All @@ -56,7 +56,7 @@

#### Defined in

[grammar.ts:201](https://github.com/mybigday/llama.rn/blob/68acf1a/src/grammar.ts#L201)
[grammar.ts:201](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/grammar.ts#L201)

___

Expand All @@ -66,7 +66,7 @@ ___

#### Defined in

[grammar.ts:203](https://github.com/mybigday/llama.rn/blob/68acf1a/src/grammar.ts#L203)
[grammar.ts:203](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/grammar.ts#L203)

___

Expand All @@ -76,7 +76,7 @@ ___

#### Defined in

[grammar.ts:199](https://github.com/mybigday/llama.rn/blob/68acf1a/src/grammar.ts#L199)
[grammar.ts:199](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/grammar.ts#L199)

___

Expand All @@ -90,7 +90,7 @@ ___

#### Defined in

[grammar.ts:207](https://github.com/mybigday/llama.rn/blob/68acf1a/src/grammar.ts#L207)
[grammar.ts:207](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/grammar.ts#L207)

___

Expand All @@ -100,7 +100,7 @@ ___

#### Defined in

[grammar.ts:209](https://github.com/mybigday/llama.rn/blob/68acf1a/src/grammar.ts#L209)
[grammar.ts:209](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/grammar.ts#L209)

___

Expand All @@ -114,7 +114,7 @@ ___

#### Defined in

[grammar.ts:205](https://github.com/mybigday/llama.rn/blob/68acf1a/src/grammar.ts#L205)
[grammar.ts:205](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/grammar.ts#L205)

## Methods

Expand All @@ -135,7 +135,7 @@ ___

#### Defined in

[grammar.ts:693](https://github.com/mybigday/llama.rn/blob/68acf1a/src/grammar.ts#L693)
[grammar.ts:693](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/grammar.ts#L693)

___

Expand All @@ -156,7 +156,7 @@ ___

#### Defined in

[grammar.ts:224](https://github.com/mybigday/llama.rn/blob/68acf1a/src/grammar.ts#L224)
[grammar.ts:224](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/grammar.ts#L224)

___

Expand All @@ -179,7 +179,7 @@ ___

#### Defined in

[grammar.ts:710](https://github.com/mybigday/llama.rn/blob/68acf1a/src/grammar.ts#L710)
[grammar.ts:710](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/grammar.ts#L710)

___

Expand All @@ -200,7 +200,7 @@ ___

#### Defined in

[grammar.ts:312](https://github.com/mybigday/llama.rn/blob/68acf1a/src/grammar.ts#L312)
[grammar.ts:312](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/grammar.ts#L312)

___

Expand All @@ -220,7 +220,7 @@ ___

#### Defined in

[grammar.ts:518](https://github.com/mybigday/llama.rn/blob/68acf1a/src/grammar.ts#L518)
[grammar.ts:518](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/grammar.ts#L518)

___

Expand All @@ -241,7 +241,7 @@ ___

#### Defined in

[grammar.ts:323](https://github.com/mybigday/llama.rn/blob/68acf1a/src/grammar.ts#L323)
[grammar.ts:323](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/grammar.ts#L323)

___

Expand All @@ -255,7 +255,7 @@ ___

#### Defined in

[grammar.ts:813](https://github.com/mybigday/llama.rn/blob/68acf1a/src/grammar.ts#L813)
[grammar.ts:813](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/grammar.ts#L813)

___

Expand All @@ -276,7 +276,7 @@ ___

#### Defined in

[grammar.ts:247](https://github.com/mybigday/llama.rn/blob/68acf1a/src/grammar.ts#L247)
[grammar.ts:247](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/grammar.ts#L247)

___

Expand All @@ -297,4 +297,4 @@ ___

#### Defined in

[grammar.ts:529](https://github.com/mybigday/llama.rn/blob/68acf1a/src/grammar.ts#L529)
[grammar.ts:529](https://github.com/mybigday/llama.rn/blob/8e54cbb/src/grammar.ts#L529)

0 comments on commit 7e394fa

Please sign in to comment.