[FEATURE] More unity of termonology across VIAME and DIVE documentation

Kitware / dive

Media annotation and analysis tools for web and desktop. Get started at https://viame.kitware.com

https://kitware.github.io/dive

Apache License 2.0

83 stars 21 forks source link

[FEATURE] More unity of termonology across VIAME and DIVE documentation #704

Open mattdawkins opened 3 years ago

mattdawkins commented 3 years ago

Mostly just want to do this by upcoming tutorials

subdavis commented 3 years ago

IMO, the clearest change we could make is to drop VIAME Web and go with DIVE Web and DIVE Desktop for these products across the board.

VIAME Web was a perfect product name when we only had one web instance, but now that there are multiple instances deployed at kitware and a desktop version, there's too much collision. Internal people are confused.

VIAME is the ML platform and product suite.
VIEW is the legacy GUI
SEAL is very clear
DIVE Web is viame.kitware.com
DIVE Desktop is the electron client

mattdawkins commented 3 years ago

Interface definitions is one thing, though my greater concern when making this was:

Overloading the terms rapid model generation and iterative learning in https://kitware.github.io/dive/Use-Cases/, which mean different things in the context of wider VIAME
Using images from possibly non-NOAA data likely without permission in https://kitware.github.io/dive/Screenshots/ (also images with not great detections and one of them that still had the boxes left of fish due to video offset issue)
Explicitly referring to DIVE and VIAME as separate modules on https://kitware.github.io/dive/. Fine for developers, not the best for end users

I'm gonna work on a PR on the last one editing that splash page a little in a few

subdavis commented 3 years ago

https://github.com/Kitware/dive/issues/704#issuecomment-819688191

Also, we should have more visible links/references to these docs from the viame/viame repo and the original viame docs. IMO, we should encourage people to start with web (more user friendly) and then fall back onto View. It would be good if we could get a clear list of what is/isn't supported on each to help people decide.

Using images from possibly non-NOAA data likely without permission in https://kitware.github.io/dive/Screenshots/ (also images with not great detections and one of them that still had the boxes left of fish due to video offset issue)

Please point to some datasets for good screenshots

aashish24 commented 3 years ago

Some food for thoughts:

VIAME is very specific vs DIVE is more general term
We may want to use VIAME-Web for marine folks and use DIVE-Web as underlying software
So depending on whether we are focusing on technology or domain we may want to market things little differently
Do we want to maket technology or domain specific tool?

waxlamp commented 2 years ago

@aashish24 as we discuss roadmapping for this project, this issue will be near-top of mind for me.