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.

Sign up for GitHub

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

Jump to bottom

Add public-facing documentation #88

Merged
merged 8 commits into from
Jan 15, 2025
Merged

Add public-facing documentation #88

merged 8 commits into from
Jan 15, 2025

Conversation

favyen2
Copy link
Collaborator

@favyen2 favyen2 commented Jan 14, 2025

No description provided.

@favyen2 favyen2 marked this pull request as draft January 14, 2025 01:51
@favyen2
Copy link
Collaborator Author

favyen2 commented Jan 14, 2025

@yawenzzzz I started adding public-facing documentation in this PR, I moved the existing docs to ai2_docs and added new docs folder intended to make it easy to understand how to train/apply the models starting with Sentinel-2 vessel detection model, let me know if you had something different in mind.

@favyen2
Copy link
Collaborator Author

favyen2 commented Jan 14, 2025

in this PR let's document Sentinel-2 vessel detection, Landsat vessel detection, and Satlas marine infrastructure prediction and then can leave the rest for later IMO.

@favyen2 favyen2 marked this pull request as ready for review January 14, 2025 21:59
@favyen2 favyen2 requested a review from yawenzzzz January 14, 2025 21:59
@favyen2
Copy link
Collaborator Author

favyen2 commented Jan 14, 2025

actually decided to do Sentinel-2 vessel detection and Satlas marine infrastructure prediction in this PR and Yawen will add Landsat in another PR

@favyen2
Copy link
Collaborator Author

favyen2 commented Jan 14, 2025

note that the marine infra documents something that will be added in #49 but I think it's okay, the other one needs to be merged soon since it includes launching workers on Beaker in a project-agnostic way

yawenzzzz
yawenzzzz approved these changes Jan 15, 2025
View reviewed changes
Copy link
Collaborator

@yawenzzzz yawenzzzz left a comment

Choose a reason for hiding this comment

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

LGTM, just two minor comments.

docs/sentinel2_vessels.md Show resolved Hide resolved
docs/sentinel2_vessels.md Outdated Show resolved Hide resolved
@favyen2 favyen2 merged commit ebb3468 into master Jan 15, 2025
5 checks passed
@favyen2 favyen2 deleted the favyen/public-docs branch January 15, 2025 20:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@yawenzzzz yawenzzzz yawenzzzz approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@favyen2 @yawenzzzz