Conversation
69456e3 to
2157bec
Compare
aacc266 to
4cbe3a2
Compare
| **`modelSource`** | ||
| A string that specifies the location of the model binary. For more information, take a look at [loading models](../fundamentals/loading-models.md) page. | ||
|
|
||
| **`preventLoad?`** - Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. |
There was a problem hiding this comment.
| **`preventLoad?`** - Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook. | |
| **`preventLoad?`** - Boolean that can prevent automatic model loading (and downloading the model if you load it for the first time) after running the hook. |
There was a problem hiding this comment.
i copied it over from other pages. I'd leave it like that - I think we actually mean it. Model loading (which mean downloading a lot of data)
There was a problem hiding this comment.
yes, but it might be misleading what data we mean
|
|
||
| // Running the model | ||
| const embedding = await ImageEmbeddingsModule.forward( | ||
| 'https://url-to-image.jpg' |
There was a problem hiding this comment.
in general i don't like things that would compile without error here, I saw too many peoples just copying it and then being upset about the url not working. Just a thought tho
There was a problem hiding this comment.
That's good point, but on the other hand it shows that any existing URL works - '...' doesn't transfer this knowledge
There was a problem hiding this comment.
I was thinking something more like ... which just wouldn't run at all and point to this as an error in code syntax itself
|
|
||
| ## Loading the model | ||
|
|
||
| To load the model, use the `load` method. It accepts the `modelSource` which is a string that specifies the location of the model binary. For more information, take a look at [loading models](../fundamentals/loading-models.md) page. This method returns a promise, which can resolve to an error or void. |
There was a problem hiding this comment.
| To load the model, use the `load` method. It accepts the `modelSource` which is a string that specifies the location of the model binary. For more information, take a look at [loading models](../fundamentals/loading-models.md) page. This method returns a promise, which can resolve to an error or void. | |
| To load the model, use the `load` method. It accepts `modelSource` which is a string that specifies the location of the model binary. For more information, take a look at [loading models](../fundamentals/loading-models.md) page. This method returns a promise which can resolve to an error or void. |
There was a problem hiding this comment.
Again - it should be fixed in several pages. I think we should utilize .mdx more
## Description Introducing image embeddings feature. TODO: benchmarks Everything else is good to review. ### Type of change - [ ] Bug fix (non-breaking change which fixes an issue) - [x] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] Documentation update (improves or adds clarity to existing documentation) ### Tested on - [x] iOS - [x] Android ### Related issues #353 ### Checklist - [x] I have performed a self-review of my code - [x] I have commented my code, particularly in hard-to-understand areas - [x] I have updated the documentation accordingly - [ ] My changes generate no new warnings ### Additional notes <!-- Include any additional information, assumptions, or context that reviewers might need to understand this PR. -->
Description
Introducing image embeddings feature.
TODO:
benchmarks
Everything else is good to review.
Type of change
Tested on
Related issues
#353
Checklist
Additional notes