Skip to content

Update README.md #34

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

Merged
merged 9 commits into from
Mar 27, 2025
Merged

Update README.md #34

merged 9 commits into from
Mar 27, 2025

Conversation

Negiiiin
Copy link
Collaborator

@Negiiiin Negiiiin commented Mar 13, 2025

Added HF links and table of contents

PR Type

[Documentation]


This change is Reviewable

Added HF links and table of contents
@Negiiiin Negiiiin requested a review from afkanpour March 13, 2025 03:22
Copy link
Collaborator

@afkanpour afkanpour left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed 1 of 1 files at r1, all commit messages.
Reviewable status: all files reviewed, 3 unresolved discussions (waiting on @Negiiiin)


README.md line 1 at r1 (raw file):

# OpenPMC-VL

Please replace all dataset names everywhere with OpenPMC

Code quote:

OpenPMC-VL

README.md line 9 at r1 (raw file):

[![license](https://img.shields.io/github/license/VectorInstitute/aieng-template.svg)](https://github.com/VectorInstitute/pmc-data-extraction/blob/main/LICENSE.md)

A toolkit to download, augment, and benchmark OpenPMC-VL; a large dataset of image-text pairs extracted from open-access scientific articles on PubMedCentral.

OpenPMC

Code quote:

OpenPMC-VL

README.md line 92 at r1 (raw file):

## Download and parse image-caption pairs from Pubmed Articles
The codebase used to download Pubmed articles and parse image-text pairs from them is stored in `openpmcvl/foundation`.

openpmc

README.md Outdated
A toolkit to download, augment, and benchmark Open-PMC; a large dataset of image-text pairs extracted from open-access scientific articles on PubMedCentral.

For more details, see the following resources:
- **arXiv Paper:** [PMC-CLIP: Contrastive Language-Image Pre-training using Biomedical Documents](http://arxiv.org/abs/2503.14377)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix the paper title

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@Negiiiin Negiiiin requested a review from afkanpour March 25, 2025 20:16
Copy link
Collaborator

@afkanpour afkanpour left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed 1 of 1 files at r2.
Reviewable status: 0 of 1 files reviewed, 10 unresolved discussions (waiting on @Negiiiin)


README.md line 12 at r2 (raw file):

For more details, see the following resources:
- **arXiv Paper:** [PMC-CLIP: Contrastive Language-Image Pre-training using Biomedical Documents](http://arxiv.org/abs/2503.14377)

Add the link on this, i.e. something like this:
[arXiv Paper:] (http://arxiv.org/abs/2503.14377)

Code quote:

arXiv Paper

README.md line 12 at r2 (raw file):

For more details, see the following resources:
- **arXiv Paper:** [PMC-CLIP: Contrastive Language-Image Pre-training using Biomedical Documents](http://arxiv.org/abs/2503.14377)

Delete this part.

Code quote:

PMC-CLIP: Contrastive Language-Image Pre-training using Biomedical Documents

README.md line 13 at r2 (raw file):

For more details, see the following resources:
- **arXiv Paper:** [PMC-CLIP: Contrastive Language-Image Pre-training using Biomedical Documents](http://arxiv.org/abs/2503.14377)
- **Dataset on Hugging Face:** [Open_PMC Dataset on Hugging Face](https://huggingface.co/datasets/vector-institute/open-pmc)

Ditto.

Code quote:

Dataset on Hugging Face

README.md line 14 at r2 (raw file):

- **arXiv Paper:** [PMC-CLIP: Contrastive Language-Image Pre-training using Biomedical Documents](http://arxiv.org/abs/2503.14377)
- **Dataset on Hugging Face:** [Open_PMC Dataset on Hugging Face](https://huggingface.co/datasets/vector-institute/open-pmc)
- **Model Checkpoint on Hugging Face:** [Open_PMC_CLIP Model Checkpoint on Hugging Face](https://huggingface.co/vector-institute/open-pmc-clip)

Ditto

Code quote:

Model Checkpoint

README.md line 27 at r2 (raw file):

- **Dataset:** [Open_PMC Dataset on Hugging Face](https://huggingface.co/datasets/vector-institute/open_pmc)
- **Checkpoint:** [Open_PMC_CLIP Model Checkpoint on Hugging Face](https://huggingface.co/vector-institute/open_pmc_clip)

This section is already above, right?

Code quote:

## Hugging Face Dataset and Checkpoint

- **Dataset:** [Open_PMC Dataset on Hugging Face](https://huggingface.co/datasets/vector-institute/open_pmc)
- **Checkpoint:** [Open_PMC_CLIP Model Checkpoint on Hugging Face](https://huggingface.co/vector-institute/open_pmc_clip)

README.md line 160 at r2 (raw file):

@article{baghbanzadeh2025advancing,
  title={Advancing Medical Representation Learning Through High-Quality Data},
  author={Baghbanzadeh, Negin and Fallahpour, Adibvafa and Parhizkar, Yasaman and Ogidi, Franklin and Roy, Shuvendu and Ashkezari, Sajad and Khazaie, Vahid Reza and Colacci, Michael and Etemad, Ali and Afkanpour, Arash and others},

Only Elham's name is missing here. Replace others with her name if possible.

Code quote:

others

README.md line 174 at r2 (raw file):

  journal={arXiv preprint arXiv:2303.07240},
  year={2023}
}

Remove this section and remove [1] above.

Code quote:

## References
<a id="1">[1]</a> PMC-OA paper:
latex
@article{lin2023pmc,
  title={PMC-CLIP: Contrastive Language-Image Pre-training using Biomedical Documents},
  author={Lin, Weixiong and Zhao, Ziheng and Zhang, Xiaoman and Wu, Chaoyi and Zhang, Ya and Wang, Yanfeng and Xie, Weidi},
  journal={arXiv preprint arXiv:2303.07240},
  year={2023}
}

@Negiiiin Negiiiin requested a review from afkanpour March 25, 2025 20:23
Copy link
Collaborator

@afkanpour afkanpour left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewable status: 0 of 1 files reviewed, 15 unresolved discussions (waiting on @Negiiiin)


README.md line 18 at r5 (raw file):

For more details, see the following resources:
- **[arXiv Paper]:** [http://arxiv.org/abs/2503.14377](http://arxiv.org/abs/2503.14377)

Remove the brackets.
arXiv Preprint:

Code quote:

[

README.md line 19 at r5 (raw file):

For more details, see the following resources:
- **[arXiv Paper]:** [http://arxiv.org/abs/2503.14377](http://arxiv.org/abs/2503.14377)
- **[Dataset]:** [Hugging Face](https://huggingface.co/datasets/vector-institute/open-pmc)

ditto

Code quote:

[

README.md line 19 at r5 (raw file):

For more details, see the following resources:
- **[arXiv Paper]:** [http://arxiv.org/abs/2503.14377](http://arxiv.org/abs/2503.14377)
- **[Dataset]:** [Hugging Face](https://huggingface.co/datasets/vector-institute/open-pmc)

delete [Hugging Face] and just use the link.

Code quote:

[Hugging Face]

README.md line 20 at r5 (raw file):

- **[arXiv Paper]:** [http://arxiv.org/abs/2503.14377](http://arxiv.org/abs/2503.14377)
- **[Dataset]:** [Hugging Face](https://huggingface.co/datasets/vector-institute/open-pmc)
- **[Model Checkpoint]:** [Hugging Face](https://huggingface.co/vector-institute/open-pmc-clip)

ditto.

Code quote:

[Model Checkpoint]:** [Hugging Face]

@Negiiiin Negiiiin requested a review from afkanpour March 25, 2025 20:46
Copy link
Collaborator

@afkanpour afkanpour left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed 1 of 1 files at r6, all commit messages.
Reviewable status: all files reviewed, 7 unresolved discussions (waiting on @Negiiiin)

@afkanpour afkanpour merged commit 59d1de1 into main Mar 27, 2025
1 check passed
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

Successfully merging this pull request may close these issues.

2 participants