Update README.md
Browse files
README.md
CHANGED
@@ -14,7 +14,7 @@ UForm is a Multi-Modal Modal Inference package, designed to encode Multi-Lingual
|
|
14 |
This is the repository of [English](https://huggingface.co/unum-cloud/uform-vl-english/tree/main) and [multilingual](https://huggingface.co/unum-cloud/uform-vl-multilingual) UForm models converted to CoreML MLProgram format.
|
15 |
Currently, only __unimodal__ parts of models are converted.
|
16 |
|
17 |
-
##
|
18 |
|
19 |
Each model is separated into two parts: `image-encoder` and `text-encoder`:
|
20 |
|
@@ -25,15 +25,18 @@ Each model is separated into two parts: `image-encoder` and `text-encoder`:
|
|
25 |
|
26 |
Each checkpoint is a zip archive with an MLProgram of the corresponding encoder.
|
27 |
|
28 |
-
|
29 |
|
30 |
* `input_ids`: int32
|
31 |
* `attention_mask`: int32
|
32 |
|
33 |
-
|
|
|
|
|
34 |
|
35 |
Both encoders return:
|
36 |
|
37 |
* `features`: float32
|
38 |
* `embeddings`: float32
|
39 |
|
|
|
|
14 |
This is the repository of [English](https://huggingface.co/unum-cloud/uform-vl-english/tree/main) and [multilingual](https://huggingface.co/unum-cloud/uform-vl-multilingual) UForm models converted to CoreML MLProgram format.
|
15 |
Currently, only __unimodal__ parts of models are converted.
|
16 |
|
17 |
+
## Description
|
18 |
|
19 |
Each model is separated into two parts: `image-encoder` and `text-encoder`:
|
20 |
|
|
|
25 |
|
26 |
Each checkpoint is a zip archive with an MLProgram of the corresponding encoder.
|
27 |
|
28 |
+
Text encoders have the following input fields:
|
29 |
|
30 |
* `input_ids`: int32
|
31 |
* `attention_mask`: int32
|
32 |
|
33 |
+
and support flexible batch size.
|
34 |
+
|
35 |
+
Image encoders has a single input field `image`: float32 and support only batch of single image (due to CoreML bug).
|
36 |
|
37 |
Both encoders return:
|
38 |
|
39 |
* `features`: float32
|
40 |
* `embeddings`: float32
|
41 |
|
42 |
+
If you want to convert a model with other parameters (i.e fp16 precision or other batch size range), you can use [convert.py](https://huggingface.co/unum-cloud/uform-coreml/blob/main/convert_model.py)
|