biolab / orange3-imageanalytics

🍊 :rice_scene: Orange3 add-on for dealing with image related tasks
GNU General Public License v3.0
32 stars 42 forks source link

Add better documentation to work on python scripts #196

Closed opengeostat closed 2 years ago

opengeostat commented 3 years ago

There is no documentation on how to use imageanalytics from a python script, for example, from a Jupyter Notebook. Please add simple examples like the one below to the documentation:

# import image analytics (installed with conda)
from orangecontrib.imageanalytics import image_embedder  

# instatntiate
emb = image_embedder.ImageEmbedder(model="squeezenet")

# embed two images by passing the file path
print(emb(['image001.jpg', 'image001.jpg']))

# embed images by passing the file path
print(emb(['image001.jpg', 'image001.jpg']))

# embed from Orange Table
import Orange
Table = Orange.data.Table('Table_with_image_path.csv')
emb_table = emb.from_table(Table)
PrimozGodec commented 3 years ago

Thank you. Will create simple documentation for image_embedder module