Skip to content

update docs at the getting started page to resemble Tim Huff's guidan… #321

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 2 commits into from
Mar 4, 2025

Conversation

jbsmith
Copy link
Contributor

@jbsmith jbsmith commented Feb 25, 2025

Initial revision to the getting started docs page to more closely resemble guidance from Tim Huff's page hosted at https://www.groundlight.ai/guides/beginner-tutorial-computer-vision-python-sdk

@tyler-romero tyler-romero self-requested a review February 25, 2025 23:56

Build a working computer vision system in just a few lines of python:
If you're new to Groundlight, this is a good place to start. Learn how to run your first computer vision application.
Copy link
Contributor

Choose a reason for hiding this comment

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

If you're new to Groundlight AI, this is a good place to start. This is the equivalent of building a "Hello, world!" application.

Don't code? Use Groundlight's no code option or reach out to Groundlight AI so we can build a custom computer vision application for you.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

Comment on lines 84 to 86
For our first demo, we’ll build a detector that checks if a trashcan is overflowing. You can copy the following code into a file inside your VSCode or check out the [github page](https://github.com/groundlight/video_tutorials/tree/main/sdk_intro).

You can start using Groundlight with a USB camera attached to your computer in just 15 lines of Python!
Copy link
Contributor

Choose a reason for hiding this comment

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

For your first and simple application you can build a binary detector, which is computer vision model where the answer will either be 'Yes' or 'No'. Groundlight AI will confirm if the thumb is facing up or down ("Is the thumb facing up?").

You can start using Groundlight using just your laptop camera, but you can also use a USB camera if you have one.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

Comment on lines 154 to 156
Want to deploy your Groundlight application on a dedicated device? See our guide on [how to use Groundlight with a Raspberry Pi](https://www.groundlight.ai/guides/raspberry-pi-tutorial).

Check out [the docs](https://code.groundlight.ai/python-sdk/) to learn how to further customize your app.
Copy link
Contributor

Choose a reason for hiding this comment

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

Now that you've built your first application, learn how to write queries.

Want to play around with sample applications built by Groundlight AI? Visit Guides to build example applications, from detecting birds outside of your window to running Groundlight AI on a Raspberry Pi.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done


In order to verify your identity while connecting to your custom ML models through our SDK, you’ll need to create an API token.

1. Head over to [http://dashboard.groundlight.ai/](http://dashboard.groundlight.ai/) and create or log into your account
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
1. Head over to [http://dashboard.groundlight.ai/](http://dashboard.groundlight.ai/) and create or log into your account
1. Head over to [https://dashboard.groundlight.ai/](https://dashboard.groundlight.ai/) and create or log into your account

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done


For our first demo, we’ll build a detector that checks if a trashcan is overflowing. You can copy the following code into a file inside your VSCode or check out the [github page](https://github.com/groundlight/video_tutorials/tree/main/sdk_intro).

You can start using Groundlight with a USB camera attached to your computer in just 15 lines of Python!
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
You can start using Groundlight with a USB camera attached to your computer in just 15 lines of Python!
For your first and simple application you can build a binary detector, which is computer vision model where the answer will either be 'Yes' or 'No'. Groundlight AI will confirm if the thumb is facing up or down ("Is the thumb facing up?").
You can start using Groundlight using just your laptop camera, but you can also use a USB camera if you have one.```

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

Comment on lines 154 to 156
Want to deploy your Groundlight application on a dedicated device? See our guide on [how to use Groundlight with a Raspberry Pi](https://www.groundlight.ai/guides/raspberry-pi-tutorial).

Check out [the docs](https://code.groundlight.ai/python-sdk/) to learn how to further customize your app.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Want to deploy your Groundlight application on a dedicated device? See our guide on [how to use Groundlight with a Raspberry Pi](https://www.groundlight.ai/guides/raspberry-pi-tutorial).
Check out [the docs](https://code.groundlight.ai/python-sdk/) to learn how to further customize your app.
Now that you've built your first application, learn how to [write queries](https://code.groundlight.ai/python-sdk/docs/getting-started/writing-queries).
Want to play around with sample applications built by Groundlight AI? Visit [Guides](https://www.groundlight.ai/guides) to build example applications, from detecting birds outside of your window to running Groundlight AI on a Raspberry Pi.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done


Build a working computer vision system in just a few lines of python:
If you're new to Groundlight, this is a good place to start. Learn how to run your first computer vision application.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
If you're new to Groundlight, this is a good place to start. Learn how to run your first computer vision application.
If you're new to Groundlight AI, this is a good place to start. This is the equivalent of building a "Hello, world!" application.
Don't code? [Reach out to Groundlight AI](mailto:[email protected]) so we can build a custom computer vision application for you.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@tyler-romero
Copy link
Contributor

Hi JB! Can you incorporate the suggested changes and then we're good to merge! Thank you

@jbsmith
Copy link
Contributor Author

jbsmith commented Feb 28, 2025

Hi JB! Can you incorporate the suggested changes and then we're good to merge! Thank you

Tyler,

Changes incorporated.
Please review and advise.

JB

Copy link
Contributor

@tyler-romero tyler-romero left a comment

Choose a reason for hiding this comment

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

Thanks! Looks good, I'll merge it after checking with Julia next week

@tyler-romero tyler-romero merged commit 83c40a0 into groundlight:main Mar 4, 2025
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