Skip to content

Readme#417

Merged
favyen2 merged 21 commits intomainfrom
gabi/readme
Nov 4, 2025
Merged

Readme#417
favyen2 merged 21 commits intomainfrom
gabi/readme

Conversation

@gabrieltseng
Copy link
Copy Markdown
Collaborator

@gabrieltseng gabrieltseng commented Oct 30, 2025

Missing:

  • Add a link to Evaluation tutorial #412 once its merged in
  • Add a license to the buttons in the top once we have one
  • Add the paper to the buttons in the top once we have a link for it

Note

Adds the OlmoEarth Artifact License and rewrites the README with badges, installation via uv, model links, usage quickstart, data summary, training/evaluation docs, and licensing info.

  • README overhaul:
    • Centered header with logo and badges (license, HF models, paper).
    • Installation: uv-based setup instructions.
    • Model summary: architecture image, size table with weights links.
    • Usage: inference quickstart and tutorial links; deployments repo link.
    • Data: dataset description, distribution map image, HF dataset link; dataset creation docs.
    • Training & Evaluation: links to pretraining and evaluation guides.
    • License: references new license.
  • Licensing:
    • Adds LICENSE with the OlmoEarth Artifact License.

Written by Cursor Bugbot for commit b7f4351. This will update automatically on new commits. Configure here.

cursor[bot]

This comment was marked as outdated.

Comment thread README.md Outdated
cursor[bot]

This comment was marked as outdated.

@gabrieltseng gabrieltseng requested a review from favyen2 November 3, 2025 18:33
@favyen2 favyen2 requested review from Hgherzog and removed request for favyen2 November 3, 2025 18:35
@favyen2
Copy link
Copy Markdown
Collaborator

favyen2 commented Nov 3, 2025

I think it would make sense to move "Deploying OlmoEarth" to the top (under Model Summary), consider renaming it "Using OlmoEarth", mention the inference quickstart guide, and instead of saying olmoearth_projects contains examples say check olmoearth_projects for examples + how to fine-tune OlmoEarth on new tasks.

Since usually people put the inference / fine-tuning stuff first because most people are looking for that rather than how to reproduce dataset creation and pre-training.

Also it is missing link to dataset creation doc.

Comment thread README.md
Comment thread README.md Outdated
Comment thread README.md
Comment thread README.md
cursor[bot]

This comment was marked as outdated.

@favyen2 favyen2 merged commit b5fb5aa into main Nov 4, 2025
5 checks passed
@favyen2 favyen2 deleted the gabi/readme branch November 4, 2025 03:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants