Sub-folders containing model-specific information

fathomnet / models

A collection of machine learning models trained on FathomNet

https://hf.co/FathomNet

26 stars 2 forks source link

Sub-folders containing model-specific information #4

Open Jordan-Pierce opened 1 year ago

Jordan-Pierce commented 1 year ago

Per the discussion, this PR contains the following:

Updated Main readme

Added the link to the publication,
Added two additional rows for projects that use FathomNet data

Sub-folders for each model

Each model has it's own sub-folder in the root of the repo with representative name
Sub-folders are relatively consistent in structure
Sub-folders contains folders for scripts, notebooks, resources, figures, and a folder containing the original repo project to easily refer back to
Sub-folder's readme(s) contain basic information, links to project / publication, and status of that model

Links to HuggingSpace demos are currently public, happy to transfer ownership and make a PR within the Fathomnet HuggingFace organization.

Take what you want, gut what you don't 😎

eor314 commented 1 year ago

I think we should merge most of this to a new branch until after we sort out our future model zoo development strategy. We should definitely merge the new model into the table in the README of main.

eor314 commented 1 year ago

@Jordan-Pierce I added you as a contributor to our HuggingFace community. Do you want to try to PR the Spaces you set up into the FathomNet community there? It'd be cool to get a sense of what the process looks like for potential future model sharing in the HF. Thanks!

Jordan-Pierce commented 1 year ago

Hey @eor314, I just transferred the spaces from my account to the FathomNet account. However, I just re-read your last comment about the PR specifically. How do you feel about me creating a Squid detector space under the FathomNet account, and while it's empty, I'll make a fork, add to the space, and then submit a PR?

Jordan-Pierce commented 1 year ago

Hey @eor314 @kevinsbarnard moving the conversation here; given the transition to HF do you just want to squash this PR? Or how would you like to proceed?

I think the only addition I have to the readme is the inclusion of the UWROV in the table, which is also apart of the FathomNet HF, might be worth adding.