Create About page to explain each of the project's role in the DeepCell ecosystem.

vanvalenlab / kiosk-frontend

DeepCell web application built using NodeJS, Express, React, and Webpack.

Other

1 stars 0 forks source link

Create About page to explain each of the project's role in the DeepCell ecosystem. #128

Closed willgraf closed 4 years ago

willgraf commented 4 years ago

Add an SVG diagram in /public/images to show on the /about page, and moved the contents of repo_explanation.md into accordian-style drop downs with the repository name as a header.

Also:

Updated @material-ui/core and @material-ui/icons to fix some deprecation warnings.
Added @svgr/webpack to enable importing SVG files as React components.
Rebuilt yarn.lock to address CVE-2020-7720

A demo is live!

MekWarrior commented 4 years ago

I think a brief description of the DeepCell ecosystem just below the figure (like a caption) would help orient the user. We can workshop what the text should be, but maybe something like the following would be appropriate:

DeepCell is a collection of resources created by the Van Valen lab to facilitate the development and application of new deep learning methods to biology. The DeepCell ecosystem seeks to address 3 interdependent needs: (1) Data Annotation and Management, (2) Model Development, and (3) Deployment and Inference.

ngreenwald commented 4 years ago

This looks great! Let me know once you guys have looked through the text and I'll make another pass through and open a PR for more cleanup

willgraf commented 4 years ago

@ngreenwald I'd like to close #122 with this PR. Is there any other content you'd like to see in the model information?

ngreenwald commented 4 years ago

I think this is a great MVP. It would be nice if there was some way to have the description of required input data for each model more easily visible from the model dropdown section on the website.

Right now, if someone goes to deepcell.org/predict, it wouldn't be obvious how to find out what the requirements are for each model, or even what the different models do.