Develop package docs #3551
Develop package docs #3551
Conversation
…he package docs page.
| To use this package, you must have the following 3rd party products: | ||
|
|
||
| * <TBC> |
There was a problem hiding this comment.
We could link to our python install docs here
There was a problem hiding this comment.
Is another Unity (Python) package considered a third-party?
There was a problem hiding this comment.
No, maybe we need a different section though to call that out as a requirement for training.
| # About Unity MLAgents package |
There was a problem hiding this comment.
according to the Package Starter Kit I think this file is supposed to be named com.unity.ml-agents.md.
| Note that this package does not contain the machine learning algorithms for training | ||
| behaviors. It relies on a Python package to orchestrate the training. This package | ||
| only enables instrumenting a Unity scene and setting it up for training. |
There was a problem hiding this comment.
Do we want to reference inference via the Barracuda package?
There was a problem hiding this comment.
Good call. @surfnerd - is there a way to link to other packages here? We can just reference them by name too.
There was a problem hiding this comment.
We can link to their docs on the unity site.
There was a problem hiding this comment.
| If you are a researcher interested in a discussion of Unity as an AI platform, see a pre-print | ||
| of our [reference paper on Unity and the ML-Agents Toolkit](https://arxiv.org/abs/1809.02627). | ||
|
|
||
| If you use Unity or the ML-Agents Toolkit to conduct research, we ask that you cite the following |
There was a problem hiding this comment.
how about we "request" instead of asking them to cite?
There was a problem hiding this comment.
I meant that we use
"... conduct research, we request that you cite the following ..."
instead of
"... conduct research, we ask that you cite the following ... "
Proposed change(s)
Useful links (Github issues, JIRA tickets, ML-Agents forum threads etc.)
Types of change(s)
Checklist
Other comments