search

imgly / background-removal-js

Remove backgrounds from images directly in the browser environment with ease and no additional costs or privacy concerns. Explore an interactive demo.
https://img.ly/showcases/cesdk/web/background-removal/web
GNU Affero General Public License v3.0
5.49k stars 339 forks source link

No models included in the npm install #105

Open ariv803 opened 4 months ago

ariv803 commented 4 months ago

In the readme in the Custom Asset serving section it says to copy the onnx and wasm files. My code is stuck at "Loading model...." debug message with no further output and the promise resolving and the program exiting, so I checked to see where it was trying to load a model from and it seems it is trying to load it from "/models/medium" , which does not exist anywhere:

(base) user@users-MacBook-Pro node_modules % cd @imgly 
(base) user@users-MacBook-Pro @imgly % ls
background-removal-node
(base) user@users-MacBook-Pro @imgly % cd background-removal-node 
(base) user@users-MacBook-Pro background-removal-node % ls
CHANGELOG.md LICENSE.md   README.md    dist         node_modules package.json
(base) user@users-MacBook-Pro background-removal-node % cd dist
(base) user@users-MacBook-Pro dist % ls
014c9e0229363137e92b85ed3c6f56b1386c279cdd9af2d7f1960ed8428b5e94 7b1dd767c5c1c0156b8d13bb34d4c1d11e014723b10cddc25c93e89a28e7cd96 index.cjs.map
01f6efcc8a01c727d99073ceede8e64c654fa3c4612b006e69e22dc663236943 897d4d8a3f9f8c07f439300a5d81c8be4b0fcecf19ca6d77929b1750fedd8306 index.d.ts
024e3d8beaf517d25496b73e36b0e0498110652753273e0dd8b591ad7c1c9e2f 8a85c22e472bed10198298a3d57480a5a90946dba88bddecf8b0bf0eafc06e70 index.d.ts.map
0ad4ebb86cfdd847901427181b7a7804dba93d868c3cd5f11a294acf36c9413f 8b2e3d773d7084c5cfac1c04d69d3586e4b8914a840d2b582dfde4940d698957 index.mjs
0c8c5c24237304482ccc70a50008b73c8ef53e4656068da32b635607cca0c8c9 9582c0375aed822c5577a814766c4afc6c096f4ccd3b0d08af6a1794987206a1 index.mjs.map
10d02652d10fbc47bf93732ff9e8ad53eefbd3bd89ab3c1fbc15ddd740bea672 9927e74b3a0638d4cf5701e78e66d77476a4ba68c75831f1c8ea9117ec7f8809 inference.d.ts
145d8355f50b7847de5d04815124790867fe1752a0013bdf6ce28882b5e0a2fc a5b8c519c832bc46b2ae5a9887fac1e3d5cc76a04846d8c3544875c7f2b40960 inference.d.ts.map
1b8eaad4cd019b76e7eba964a38711a0bdeafbd10b6208c1107403a64dbd902a b34a3e9350ad77140964b6a2e1e32cd9738acd9d01e5899b96be71901a22ef47 onnx.d.ts
230f667e0332dc09ef08aacbf1992c40ce112192f95dfc14231a3ef515f9a2c7 b9861d932a549be455fc8ebd8ce5d413049515bfdd3edd55e136dbe05dd34ef5 onnx.d.ts.map
3315eb3c14ca3ff5c03c80fac58f486a14264dd0bb9c168c096f2bd2531ba438 cbcda0a0c830ba51928e7935d9d3cfe1c4dc258bf117f2c76d047113ab8f9f8c resource.d.ts
34dd3ad760f7e31b5e9144b8c387b8ecd6dc43116248c93c56dd7051ab525e3b codecs.d.ts                                                      resource.d.ts.map
3f31511c3c16a29cf81b32379f51ead2bd082677b48b1dcc11a66beeb37cc729 codecs.d.ts.map                                                  resources.json
3f5638267419916c9d4d906ff25f721d3d2e034851ea01566f0d2d6f943550b8 e01a157b677e0e17815cd738dcda7e6daa268898d006b52b5d3604c439e6c96e schema.d.ts
4c44c8b64af9f044623ceace7cc55e0bc348394f7ff63629d46118c0a03c9c54 e7ca5cc3e0afd65581642a05ac91eb8ea4d0deb868df94b8981c910212526476 schema.d.ts.map
529f1df7d027b0315090ba15d42ef32998cac2efd6783c62f6b11cedf4c548f3 f070b4c4f512cfe8dd6936c3cb9a616f132894867d3d33304d83599eb6b55636 url.d.ts
5faec25d2338ae8ca2c7bff72e954cebd40a04c5f34c4b6bb8ca6720fae40996 f9290547b2e34555536647c1e2ca456348170eef1aee05d8fd522f5a051f260c url.d.ts.map
6cfd013f552a05e9fc81156e6d6de593668e0247a3970feae22e285c16d13e62 fe1b9f06af9d2147016884f4eb683d4dc540244a7453c3b742ae527725df2eec utils.d.ts
724543b36c7b5eddfbd7f55cb5a7c1676b2089c277611850c257efa42212d8a2 index.cjs                                                        utils.d.ts.map

I think the models can be downloaded from here so I will try that: https://github.com/imgly/background-removal-js/tree/main/bundle/models It would be great to throw an error or include them in the NPM install or edit the README with additional instructions though. My use case is a backend NodeJS service with no browser involved.

ariv803 commented 4 months ago

seems to be failing at the line where it requires resources.json

resourceURi file:///Users/user/dev/work/aaa/node_modules/@imgly/background-removal-node/dist/resources.json

ariv803 commented 4 months ago

also, where do the models come from in case I want to check for updated versions? I mean is there a different git repo or website that this project is getting them from?

favger commented 3 months ago

How can I use the large model? When I downloaded package version 1.4.5, it does not come with the large model, only the small and medium models. How can I use the large model?

ariv803 commented 3 months ago

@favger you can download it from the github website I think (download as zip). Not sure how you downloaded the package version (maybe you did an npm install) but you can see it here https://github.com/imgly/background-removal-js/tree/main/bundle/models