Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
EricLBuehler committed Sep 11, 2023
1 parent 4f4b8c7 commit d853c5b
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,14 @@ candle-lora is able to convert:

All conversions are done as implemented in HuggingFace's official LoRA implementation.

Current working example:
## How to use
1) Replace any concrete `Linear`, `Conv1d`, `Conv2d`, or `Embedding` types with `Box<dyn ...LayerLike>`. This will allow `candle-lora` to
generate new layers that can easily be swaped out without forcing you to redefine your model structs.
2) Select the layers and perform the conversion.
3) Swap out the layers.
4) Enjoy your new LoRA model!

## Example
```rust
use std::{collections::HashMap, hash::Hash};

Expand Down

0 comments on commit d853c5b

Please sign in to comment.