Skip to content

Add serve deploy and quickstart guides.#754

Open
gh0st-ryder wants to merge 1 commit intoNVIDIA:mainfrom
gh0st-ryder:add-markdowns
Open

Add serve deploy and quickstart guides.#754
gh0st-ryder wants to merge 1 commit intoNVIDIA:mainfrom
gh0st-ryder:add-markdowns

Conversation

@gh0st-ryder
Copy link
Collaborator

Earth2Studio Pull Request

Description

  • Adds a lepton.ai deployment guide for serve.
  • Adds a quickstart guide for serve.
  • Corrects some imports in the obj storage readme.

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.
  • The CHANGELOG.md is up to date with these changes.
  • An issue is linked to this pull request.
  • Assess and address Greptile feedback (AI code review bot for guidance; use discretion, addressing all feedback is not required).

Dependencies

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Mar 16, 2026

Greptile Summary

This PR adds two new documentation files for the Earth2Studio serve platform and fixes incorrect import paths in an existing doc:

  • serve/DEPLOY.md: New Lepton.AI deployment guide covering dashboard configuration, container image setup, storage mounts, access tokens, and debugging.
  • serve/README.md: New quickstart guide with developer setup instructions, an inline Python workflow example, container build references, and links to additional workflow docs.
  • serve/server/README_object_storage.md: Corrects three stale import paths from the old api_client.* namespace to the current earth2studio.serve.client.* package paths. All corrected paths have been verified to exist in the codebase.

The PR is documentation-only with no functional code changes. The import path corrections in the object storage README are accurate and align with the current module structure.

Confidence Score: 5/5

  • This PR is safe to merge — it contains only documentation additions and import path corrections with no functional code changes.
  • Score of 5 reflects that this is a documentation-only PR with no risk of runtime impact. The import path corrections are verified to be accurate, and the new guides are well-structured.
  • No files require special attention.

Important Files Changed

Filename Overview
serve/DEPLOY.md New Lepton.AI deployment guide with dashboard setup instructions, storage configuration, and debugging tips. Straightforward documentation, no issues found.
serve/README.md New quickstart guide with developer setup, inline Python example, container build instructions, and deployment references. The inline example diverges slightly from the actual source file it references.
serve/server/README_object_storage.md Corrects three import paths from old api_client.* module paths to the current earth2studio.serve.client.* paths. All corrected paths verified to exist in the codebase.

Last reviewed commit: 6e4463a

Comment on lines +82 to +94
start_time: list[datetime] = [datetime(2024, 1, 1, 0)],
num_steps: int = 20,
):
"""Run the deterministic workflow pipeline"""

run.deterministic(start_time, num_steps, self.model, self.data, io)

print("initializing ")
model = DeterministicEarth2Workflow()
print("calling model")
from earth2studio.io import ZarrBackend
io = ZarrBackend()
model(io)
Copy link
Contributor

Choose a reason for hiding this comment

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

Mutable default argument in documentation example

The start_time parameter uses a mutable default argument ([datetime(2024, 1, 1, 0)]), which is a well-known Python pitfall — the list is shared across all calls that don't provide this argument. This same pattern exists in the source file server/example_workflows/deterministic_earth2_workflow.py, so it's a pre-existing issue, but since this README is meant to guide new users, it may be worth using an immutable default (e.g., None with a check inside the method body) to avoid teaching the anti-pattern.

Additionally, the num_steps default here is 20, while the actual source file uses 6. If the intent is to mirror the source file, consider keeping these in sync to avoid confusion.

@gh0st-ryder
Copy link
Collaborator Author

/blossom-ci

Copy link
Collaborator

@shrek shrek left a comment

Choose a reason for hiding this comment

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

these are doc changes, and lgtm !

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.

3 participants