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

Updated README files. #554

Open
wants to merge 66 commits into
base: master
Choose a base branch
from
Open

Updated README files. #554

wants to merge 66 commits into from

Conversation

Ian-Erickson
Copy link
Contributor

Updated and created README files for various models with in the model_zoo folder. In addition to updating the tensorize_dataflow.py README within the tensorize folder.

Lreg.png and LSeg.png are those image files. README is a first draft and under review.
…magnetic resonance–derived left ventricular mass to be a link.
Attempting to have the images render correctly.
…Variant.

Additionally removed unnecessary linebreak.
I wasn't sure if it made sense in the README.
"Machine learning enables new insights into clinical significance of and genetic contributions to liver fat accumulation" to be exact. I believe I have found the specific paper about this model.
…c Magnetic Resonance-Derived Left Ventricular Mass and Hypertrophy from 12-Lead Electrocardiograms"

The paper links directly back the ML4H Github.
…mages" a link to the article describing the model.
…aper on this model.

The heading of this README was not close to the title of the paper. So I decided to put the link in the citation instead.
I may have had it link to a very similar article from the same authors.
…article.

I can't tell if the names of the same article are different, or they're two different but very similar articles.
…student_and_mri_teacher.

Moved description of each model to their own line for easier reading. Also changed some commas to periods. Also made the sentence "Three pre-trained models are included here" end in a colon.
…entricular_mass

Put some sentences on the same line, changed the tense to present tense in the 4th line, and removed the line from the original paper pointing the reader back to this Github.
…the image in the README link directly to the added local file.
… down the alt text of the images.

(cardiac_mri_derived_left_ventricular_mass/README.md)
Please correct me if "the models were trained with the InlineVF contours" and "we trained with the InlineVF" are not equivalent statements.
The README of cardiac_mri_derived_left_ventricular_mass to be exact.
architecture_graph_sax_diastole_segment_no_flat.png is not returning.
All images which matches it's description "An overview of the models layers" were already in the results section.
Deleting test image with git rm looks very different from using git rm on an image tracked with git lfs.
This appears to be the version on Github despite not being on my local machine...
The capital S one shouldn't be there. But doing this removes Lseg with a lower case L.
Includes a list and description of parameters from tensorize_dataflow.py.
The parameters for the example command were changed to more clearly be placeholders. This will hopefully prevent accidentally outputting to tensors/continuous_v2023_01_17.
This makes it more consistent with the rest of the README.
These are not present in the example command. But should probably be included regardless.
@Ian-Erickson Ian-Erickson added the documentation Documentation, READMEs, etc. label Mar 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation, READMEs, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant