浏览代码

Merge pull request #466 from Unity-Technologies/docs/doxygen

Finalized doxygen pages
/develop-generalizationTraining-TrainerController
GitHub 7 年前
当前提交
255063d7
共有 6 个文件被更改,包括 35 次插入42 次删除
  1. 10
      docs/Readme.md
  2. 33
      docs/dox-ml-agents.conf
  3. 2
      docs/doxygen/Readme.md
  4. 8
      unity-environment/Assets/ML-Agents/Scripts/Agent.cs
  5. 2
      unity-environment/Assets/ML-Agents/Scripts/CoreBrainHeuristic.cs
  6. 22
      docs/API-Reference.md

10
docs/Readme.md


* [ML-Agents Glossary](Glossary.md)
* [Limitations & Common Issues](Limitations-and-Common-Issues.md)
## C# API and Components
* Academy
* Agent
* Decision
* Monitor
## Python API
## API Docs
* [API Reference](API-Reference.md)

33
docs/dox-ml-agents.conf


# could be handy for archiving the generated documentation or if some version
# control system is used.
PROJECT_NUMBER = v0.2
PROJECT_NUMBER = v0.3
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a

# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
INPUT = ML-Agents-Overview.md \
Background-Unity.md \
Background-Machine-Learning.md \
Background-TensorFlow.md \
Installation.md \
Installation-Docker.md \
Background-Jupyter.md \
Getting-Started-with-Balance-Ball.md \
Learning-Environment-Examples.md \
Learning-Environment-Create-New.md \
Learning-Environment-Design.md \
Learning-Environment-Design-Agents.md \
Learning-Environment-Design-Academy.md \
Learning-Environment-Design-Brains.md \
Training-ML-Agents.md \
Training-PPO.md \
Training-Curriculum-Learning.md \
Training-Imitation-Learning.md \
Using-TensorFlow-Sharp-in-Unity.md \
Training-on-Amazon-Web-Service.md \
Using-Tensorboard.md \
Python-API.md \
Feature-Broadcasting.md \
Feature-Monitor.md \
Limitations-and-Common-Issues.md \
../unity-environment/Assets/ML-Agents/Scripts \
../python/unityagents
INPUT = ../unity-environment/Assets/ML-Agents/Scripts/Academy.cs \
../unity-environment/Assets/ML-Agents/Scripts/Agent.cs \
../unity-environment/Assets/ML-Agents/Scripts/Monitor.cs \
../unity-environment/Assets/ML-Agents/Scripts/Decision.cs
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

2
docs/doxygen/Readme.md


To generate the API reference as HTML files, run:
doxygen ml-agents.conf
doxygen dox-ml-agents.conf

8
unity-environment/Assets/ML-Agents/Scripts/Agent.cs


public bool resetOnDone = true;
/// <summary>
/// Whether to enable On Demand Decision Making or make a decision at
/// Whether to enable On Demand Decisions or make a decision at
/// Number of actions between decisions (used when On Demand Decision
/// Making is turned off).
/// Number of actions between decisions (used when On Demand Decisions
/// is turned off).
/// </summary>
public int numberOfActionsBetweenDecisions;
}

int stepCount;
// Flag to signify that an agent has been reset but the fact that it is
// done has not been communicated (required for On Demand Decision Making).
// done has not been communicated (required for On Demand Decisions).
bool hasAlreadyReset;
// Flag to signify that an agent is done and should not reset until

2
unity-environment/Assets/ML-Agents/Scripts/CoreBrainHeuristic.cs


using UnityEditor;
#endif
/// CoreBrain which decides actions using developer-provided Decision.cs script.
/// CoreBrain which decides actions using developer-provided Decision script.
public class CoreBrainHeuristic : ScriptableObject, CoreBrain
{
[SerializeField]

22
docs/API-Reference.md


# API Reference
Our developer-facing C# classes (Academy, Agent, Decision and
Monitor) have been documented to be compatabile with
[Doxygen](http://www.stack.nl/~dimitri/doxygen/) for auto-generating HTML
documentation.
To generate the API reference,
[download Doxygen](http://www.stack.nl/~dimitri/doxygen/download.html) and run
the following command within the `docs/` directory:
doxygen dox-ml-agents.conf
`dox-ml-agents.conf` is a Doxygen configuration file for ML-Agents
that includes the classes that have been properly formatted.
The generated HTML files will be placed
in the `html/` subdirectory. Open `index.html` within that subdirectory to
navigate to the API reference home. Note that `html/` is already included in
the repository's `.gitignore` file.
In the near future, we aim to expand our documentation
to include all the Unity C# classes and Python API.
正在加载...
取消
保存