Doodleverse / segmentation_zoo

A collection of geoscientific image segmentation models
MIT License
8 stars 3 forks source link

Add 4 Roles to wiki #6

Open ebgoldstein opened 2 years ago

ebgoldstein commented 2 years ago
dbuscombe-usgs commented 2 years ago

I made this figure for the 'contributor' role. lmk what you think. we could include it in the wiki

Doodleverse_contributor

dbuscombe-usgs commented 2 years ago

The Doodleverse 'experimenter'. Either this or a tarot card

Experimenter

dbuscombe-usgs commented 2 years ago

CoastSeg user, using Zoo models for either shoreline or mapping using zoo models Doodleverse_CoastSeg_user_zoo

dbuscombe-usgs commented 2 years ago

this role I call the 'basic user', who in reality is likely the most advanced, using Doodler and Gym to make a model then seeya ... this would be most researchers perhaps

Doodleverse_basic_user

Not sure this last one is within the scope of CoastSeg ... this is more like a different project, 'Seg2Map', but i include it for completeness

Doodleverse_CoastSeg_user_custom

dbuscombe-usgs commented 2 years ago

I will include and flesh out ideas in the next wiki upgrade

dbuscombe-usgs commented 2 years ago

@ebgoldstein is this still a good idea?

ebgoldstein commented 2 years ago

i think we still need to clearly define what Zoo is, and how to interact with it... These roles might not be correct anymore, but i do think we need a clear "what is Zoo', how to participate, how to use, etc.....

dbuscombe-usgs commented 2 years ago

I think Zoo is 4 things:

  1. a README, enacting a convenient place to document Gym models that have been made publicly available through a zenodo release. The zenodo releases contain at least the model weights, config file, and a model card. Optionally, that model release may also contain the images and labels used to make the model. Models are only briefly listed in the README.
  2. a wiki that includes an overview of each model - 1 wiki page per model
  3. a call for new models that may be of general interest to the geoscience community, contributed by the geoscience community, and organised in the same way (zenodo release, model card, wiki page)
  4. a collection of example model implementations - there are script and notebook folders that contain example implementations. These implementations would cover basic implementations, and advanced implementations such as ensembling and transfer learning

Zoo could also link to case studies and papers that use Gym models, for wider accounting and promotion of the Doodleverse workflow

dbuscombe-usgs commented 2 years ago

The above vision provisions for the following roles:

  1. user - (git cloner)
  2. contributor of models (pull requester)
  3. contributor of implementation workflows (pull requester)
dbuscombe-usgs commented 2 years ago

I made this figure for the 'contributor' role. lmk what you think. we could include it in the wiki

Doodleverse_contributor

As such, perhaps only this graphic is now useful (?) as contributor of models .... many months on, it seems overkill

dbuscombe-usgs commented 2 years ago

Minor update to readme to try to better reflect Zoo's goals and roles https://github.com/Doodleverse/segmentation_zoo/commit/325a61ae7a254c56c342d4760e0aae53ff3cad2b

dbuscombe-usgs commented 1 year ago

I think user roles (3 of them identified on the readme) are clear. @ebgoldstein , if you like, we could simulate what a PR would look like for a "model contributor" role when you update the NOAA model?