Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add 4 Roles to wiki #6

Open
4 tasks
ebgoldstein opened this issue Feb 24, 2022 · 12 comments
Open
4 tasks

Add 4 Roles to wiki #6

ebgoldstein opened this issue Feb 24, 2022 · 12 comments
Assignees

Comments

@ebgoldstein
Copy link
Member

  • Contributor
  • Experimentor (with and w/o ground truth)
  • Shoreline (via CoastSeg)
  • Maintainer
@ebgoldstein ebgoldstein self-assigned this Feb 24, 2022
@dbuscombe-usgs
Copy link
Member

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

Doodleverse_contributor

@dbuscombe-usgs
Copy link
Member

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

Experimenter

@dbuscombe-usgs
Copy link
Member

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

@dbuscombe-usgs
Copy link
Member

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
Copy link
Member

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

@dbuscombe-usgs
Copy link
Member

@ebgoldstein is this still a good idea?

@ebgoldstein
Copy link
Member Author

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
Copy link
Member

dbuscombe-usgs commented Oct 17, 2022

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
Copy link
Member

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
Copy link
Member

dbuscombe-usgs commented Oct 17, 2022

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
Copy link
Member

Minor update to readme to try to better reflect Zoo's goals and roles 325a61a

2320sharon pushed a commit that referenced this issue Dec 7, 2022
2320sharon pushed a commit that referenced this issue Dec 7, 2022
@dbuscombe-usgs
Copy link
Member

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants