Documentation Additions #2
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
isaacrob
requested changes
Jan 31, 2024
README.md
Outdated
| ## Next Steps | ||
| To write code to use the motion detector output, use one of the [available SDKs](https://docs.viam.com/program/). | ||
|
|
||
| Please join [DirectAI's discord](https://discord.com/invite/APU6MWBKQv), contact us at [[email protected]](mailto:[email protected]), or schedule time on our calendly if you have any questions or feedback! |
README.md
Outdated
| |------|------|-----------|-------------| | ||
| | `access_json` | string | **Required** | A string that indicates an absolute path on your local machine to a JSON including DirectAI Client Credentials. See description in [Example Access JSON](#example-access-json) section. | | ||
| | `deployed_classifier` | json | **Optional** | A JSON that contains a `classifier_configs` key and corresponding list of classifier configurations. Each classifier is defined by a `name`, a list of text `examples_to_include`, and a list of text `examples_to_exclude`. See [Example Classifier Attributes](#example-classifier-attributes). | | ||
| | `deployed_detector` | json | **Optional** | A JSON that contains a `detector_configs` key and corresponding list of detector configurations. Each detector is defined by a `name`, a list of text `examples_to_include`, and a list of text `examples_to_exclude`. See [Example Detector Attributes](#example-detector-attributes). | |
There was a problem hiding this comment.
detection threshold / nms threshold?
README.md
Outdated
| ## Configuration | ||
|
|
||
| Navigate to the **Config** tab of your robot’s page in [the Viam app](https://app.viam.com/). Click on the **Services** subtab and click **Create service**. Select the `vision` type, then select the `directai-beta` model. Enter a name for your service and click **Create**. | ||
|
|
||
| ### Example Configuration | ||
| On the new component panel, copy and paste the Example Detector *or* Classifier Attributes. Ensure that the Access JSON path that you provide in your Config is **absolute**, not relative. (e.g. `/Users/janesmith/Downloads/directai_credential.json`, not `~/Downloads/directai_credential.json`) |
There was a problem hiding this comment.
should be able to do both detector and classifier in one json
There was a problem hiding this comment.
I opted to show one at a time for simplicity but I can make a mention of it in the description. happy to discuss more if need be
There was a problem hiding this comment.
update: made a note
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary:
Adding explanation to closely match viam's motion detector docs.
See rendering of README here.