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 21, 2024
1 parent 276a90a commit d577c5a
Show file tree
Hide file tree
Showing 5 changed files with 112 additions and 60 deletions.
51 changes: 26 additions & 25 deletions docs/API/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ llama.rn

#### Defined in

[index.ts:84](https://github.com/mybigday/llama.rn/blob/0c04b5e/src/index.ts#L84)
[index.ts:103](https://github.com/mybigday/llama.rn/blob/276a90a/src/index.ts#L103)

___

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

#### Defined in

[index.ts:75](https://github.com/mybigday/llama.rn/blob/0c04b5e/src/index.ts#L75)
[index.ts:94](https://github.com/mybigday/llama.rn/blob/276a90a/src/index.ts#L94)

___

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

#### Defined in

[index.ts:64](https://github.com/mybigday/llama.rn/blob/0c04b5e/src/index.ts#L64)
[index.ts:67](https://github.com/mybigday/llama.rn/blob/276a90a/src/index.ts#L67)

___

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

#### Defined in

[index.ts:73](https://github.com/mybigday/llama.rn/blob/0c04b5e/src/index.ts#L73)
[index.ts:92](https://github.com/mybigday/llama.rn/blob/276a90a/src/index.ts#L92)

___

Expand Down Expand Up @@ -138,7 +138,7 @@ ___

#### Defined in

[NativeRNLlama.ts:50](https://github.com/mybigday/llama.rn/blob/0c04b5e/src/NativeRNLlama.ts#L50)
[NativeRNLlama.ts:60](https://github.com/mybigday/llama.rn/blob/276a90a/src/NativeRNLlama.ts#L60)

___

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

#### Defined in

[NativeRNLlama.ts:195](https://github.com/mybigday/llama.rn/blob/0c04b5e/src/NativeRNLlama.ts#L195)
[NativeRNLlama.ts:205](https://github.com/mybigday/llama.rn/blob/276a90a/src/NativeRNLlama.ts#L205)

___

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

#### Defined in

[NativeRNLlama.ts:184](https://github.com/mybigday/llama.rn/blob/0c04b5e/src/NativeRNLlama.ts#L184)
[NativeRNLlama.ts:194](https://github.com/mybigday/llama.rn/blob/276a90a/src/NativeRNLlama.ts#L194)

___

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

#### Defined in

[NativeRNLlama.ts:179](https://github.com/mybigday/llama.rn/blob/0c04b5e/src/NativeRNLlama.ts#L179)
[NativeRNLlama.ts:189](https://github.com/mybigday/llama.rn/blob/276a90a/src/NativeRNLlama.ts#L189)

___

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

#### Defined in

[NativeRNLlama.ts:174](https://github.com/mybigday/llama.rn/blob/0c04b5e/src/NativeRNLlama.ts#L174)
[NativeRNLlama.ts:184](https://github.com/mybigday/llama.rn/blob/276a90a/src/NativeRNLlama.ts#L184)

___

Expand All @@ -239,8 +239,9 @@ ___
| `embedding?` | `boolean` | - |
| `flash_attn?` | `boolean` | Enable flash attention, only recommended in GPU device (Experimental in llama.cpp) |
| `is_model_asset?` | `boolean` | - |
| `lora?` | `string` | - |
| `lora_scaled?` | `number` | - |
| `lora?` | `string` | Single LoRA adapter path |
| `lora_list?` | { `path`: `string` ; `scaled?`: `number` }[] | LoRA adapter list |
| `lora_scaled?` | `number` | Single LoRA adapter scale |
| `model` | `string` | - |
| `n_batch?` | `number` | - |
| `n_ctx?` | `number` | - |
Expand All @@ -256,7 +257,7 @@ ___

#### Defined in

[NativeRNLlama.ts:8](https://github.com/mybigday/llama.rn/blob/0c04b5e/src/NativeRNLlama.ts#L8)
[NativeRNLlama.ts:8](https://github.com/mybigday/llama.rn/blob/276a90a/src/NativeRNLlama.ts#L8)

___

Expand All @@ -272,7 +273,7 @@ ___

#### Defined in

[NativeRNLlama.ts:4](https://github.com/mybigday/llama.rn/blob/0c04b5e/src/NativeRNLlama.ts#L4)
[NativeRNLlama.ts:4](https://github.com/mybigday/llama.rn/blob/276a90a/src/NativeRNLlama.ts#L4)

___

Expand All @@ -288,7 +289,7 @@ ___

#### Defined in

[NativeRNLlama.ts:215](https://github.com/mybigday/llama.rn/blob/0c04b5e/src/NativeRNLlama.ts#L215)
[NativeRNLlama.ts:225](https://github.com/mybigday/llama.rn/blob/276a90a/src/NativeRNLlama.ts#L225)

___

Expand All @@ -307,7 +308,7 @@ ___

#### Defined in

[NativeRNLlama.ts:219](https://github.com/mybigday/llama.rn/blob/0c04b5e/src/NativeRNLlama.ts#L219)
[NativeRNLlama.ts:229](https://github.com/mybigday/llama.rn/blob/276a90a/src/NativeRNLlama.ts#L229)

___

Expand All @@ -324,7 +325,7 @@ ___

#### Defined in

[NativeRNLlama.ts:226](https://github.com/mybigday/llama.rn/blob/0c04b5e/src/NativeRNLlama.ts#L226)
[NativeRNLlama.ts:236](https://github.com/mybigday/llama.rn/blob/276a90a/src/NativeRNLlama.ts#L236)

___

Expand All @@ -340,7 +341,7 @@ ___

#### Defined in

[NativeRNLlama.ts:211](https://github.com/mybigday/llama.rn/blob/0c04b5e/src/NativeRNLlama.ts#L211)
[NativeRNLlama.ts:221](https://github.com/mybigday/llama.rn/blob/276a90a/src/NativeRNLlama.ts#L221)

___

Expand All @@ -356,7 +357,7 @@ ___

#### Defined in

[chat.ts:3](https://github.com/mybigday/llama.rn/blob/0c04b5e/src/chat.ts#L3)
[chat.ts:3](https://github.com/mybigday/llama.rn/blob/276a90a/src/chat.ts#L3)

___

Expand All @@ -373,7 +374,7 @@ ___

#### Defined in

[chat.ts:7](https://github.com/mybigday/llama.rn/blob/0c04b5e/src/chat.ts#L7)
[chat.ts:7](https://github.com/mybigday/llama.rn/blob/276a90a/src/chat.ts#L7)

___

Expand All @@ -390,7 +391,7 @@ ___

#### Defined in

[index.ts:54](https://github.com/mybigday/llama.rn/blob/0c04b5e/src/index.ts#L54)
[index.ts:57](https://github.com/mybigday/llama.rn/blob/276a90a/src/index.ts#L57)

## Functions

Expand All @@ -414,7 +415,7 @@ ___

#### Defined in

[grammar.ts:826](https://github.com/mybigday/llama.rn/blob/0c04b5e/src/grammar.ts#L826)
[grammar.ts:826](https://github.com/mybigday/llama.rn/blob/276a90a/src/grammar.ts#L826)

___

Expand All @@ -435,7 +436,7 @@ ___

#### Defined in

[index.ts:251](https://github.com/mybigday/llama.rn/blob/0c04b5e/src/index.ts#L251)
[index.ts:295](https://github.com/mybigday/llama.rn/blob/276a90a/src/index.ts#L295)

___

Expand All @@ -455,7 +456,7 @@ ___

#### Defined in

[index.ts:236](https://github.com/mybigday/llama.rn/blob/0c04b5e/src/index.ts#L236)
[index.ts:280](https://github.com/mybigday/llama.rn/blob/276a90a/src/index.ts#L280)

___

Expand All @@ -469,7 +470,7 @@ ___

#### Defined in

[index.ts:301](https://github.com/mybigday/llama.rn/blob/0c04b5e/src/index.ts#L301)
[index.ts:354](https://github.com/mybigday/llama.rn/blob/276a90a/src/index.ts#L354)

___

Expand All @@ -489,4 +490,4 @@ ___

#### Defined in

[index.ts:222](https://github.com/mybigday/llama.rn/blob/0c04b5e/src/index.ts#L222)
[index.ts:266](https://github.com/mybigday/llama.rn/blob/276a90a/src/index.ts#L266)
Loading

0 comments on commit d577c5a

Please sign in to comment.