chmjkb commited on
Commit
70ddeb8
·
1 Parent(s): 9d11394

Update README

Browse files
Files changed (1) hide show
  1. README.md +26 -0
README.md CHANGED
@@ -1,3 +1,29 @@
1
  ---
2
  license: apache-2.0
 
 
 
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: apache-2.0
3
+ pipeline_tag: text-generation
4
+ tags:
5
+ - executorch
6
  ---
7
+
8
+ # Introduction
9
+
10
+ This repository hosts the **Bielik-v3.0** models for the [React Native ExecuTorch](https://www.npmjs.com/package/react-native-executorch) library. It includes **unquantized** and **quantized** versions of the Bielik (instruct) model in `.pte` format, ready for use in the **ExecuTorch** runtime.
11
+
12
+ If you'd like to run these models in your own ExecuTorch runtime, refer to the [official documentation](https://pytorch.org/executorch/stable/index.html) for setup instructions.
13
+
14
+ ## Compatibility
15
+
16
+ If you intend to use this model outside of React Native ExecuTorch, make sure your runtime is compatible with the **ExecuTorch** version used to export the `.pte` files. For more details, see the compatibility note in the [ExecuTorch GitHub repository](https://github.com/pytorch/executorch/blob/11d1742fdeddcf05bc30a6cfac321d2a2e3b6768/runtime/COMPATIBILITY.md?plain=1#L4). If you work with React Native ExecuTorch, the constants from the library will guarantee compatibility with runtime used behind the scenes.
17
+
18
+ These models were exported using `v1.0.0` version and **no forward compatibility** is guaranteed. Older versions of the runtime may not work with these files.
19
+
20
+ ### Repository Structure
21
+
22
+ The repository contains a single main directory:
23
+
24
+ - `bielik-v3.0-1.5B`
25
+
26
+ Each directory contains different versions of the model, including **quantized**, and the **original** models.
27
+
28
+ - The `.pte` file should be passed to the `modelSource` parameter.
29
+ - The tokenizer for the models is available within the repo root, under `tokenizer.json` and `tokenizer_config.json`