完善一些api 描述 #82
Open
完善一些api 描述 #82
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
Remove DS_Store file and add to .gitignore
更新user_guide/getting_started/soft_robots.md中的两个超链接，原链接仓库已失效，改为https://github.com/Genesis-Embodied-AI中的文件链接
update wrong hyperlink
Update visualization.md: add a space between raytracing
- Replaced "creaing" with "creating" - Replaced "accidently" with "accidentally"
docs: fix minor spelling errors in diff-sim doc.
This commit includes Training Drone Hovering Policies with RL, without demo videos.
add demo video to html
Update Drone Hovering Tutorial
Fix typo in collision_representation.md
change hyper params update curve, eval_video and add training.gif
update hover_env.md with images and videos
Added a complete name and link to the shorthand reference to a PD controller. Probably people coming from the more software side of things would not understand what PD stands for.
Update control_your_robot.md
Add Manipulation with Two Stage Training
…x_missing_misc Fix missing file.
为 PBD 实体和 Avatar 实体相关文档添加详细的功能说明、属性描述和代码示例，包括： 1. PBDEntity 及其子类（粒子、2D、3D、四面体等）的文档 2. AvatarEntity 及其组件（Link、Joint、Geom）的文档 3. 每个类的主要属性、方法和使用示例
更新刚体实体相关文档，包括RigidEntity、RigidLink、RigidJoint、RigidGeom和RigidVisGeom的详细说明、属性列表和代码示例 移除PBD实体文档中的示例代码，保持文档一致性
- 为Mesh、Scene、Rigid、Avatar、Options、Simulator、DroneEntity等类添加详细功能说明和属性表格 - 删除已废弃的hybrid.md文件 - 统一ForceField命名格式并添加类继承关系说明 - 为Camera、FEMEntity、MPMEntity等类添加详细文档 - 移除rigid_entity相关文档中的代码示例部分
为 FEM 和 MPM 材料类添加详细的中文文档说明，包括： - 每个材料类的概述和主要功能 - 参数说明表格，包含参数名、类型、默认值和描述 - 统一了文档格式和结构
为PBD和SPH材料模块添加详细概述、使用场景、特点说明和参数表格 包括PBD模块的粒子、液体、布料、弹性体材料文档 以及SPH模块的液体材料文档
为Morph及其子类文档添加概述、主要功能和详细的参数说明表格，包括Morph、Primitive、FileMorph及其具体实现类（如Box、Sphere、Cylinder、Plane、URDF、MJCF、Drone等）的文档内容
重构渲染器和模拟器选项的文档，添加详细的功能说明和参数表格 删除冗余的renderer.md文件，新增sap_coupler_options.md和rendereroptions.md 统一各选项文档的格式，提供更清晰的API参考
为Genesis引擎的各类材质（金属、塑料、玻璃、自发光等）添加详细的参数说明、主要功能描述和使用示例，提升文档完整性和实用性。包括： 1. 添加材质概述和主要特点 2. 详细列出所有参数及其默认值 3. 提供典型使用示例 4. 补充材质间的继承关系和兼容性说明 5. 增强技术细节描述，如光线追踪兼容性等
添加纹理系统概述文档，包括Texture基类、ColorTexture和ImageTexture的详细说明 包含主要功能、参数说明和使用注意事项等内容
添加了可视化系统的详细文档，包括 ViewerOptions 和 VisOptions 类的参数说明和功能描述，帮助用户更好地理解和使用 Genesis API 的可视化功能
添加场景管理的主要特点说明和详细方法列表 补充力场使用示例代码，包括恒定力场、风力场、点力场和自定义力场
- 新增 ToolEntity 和 SFEntity 的 API 文档 - 在实体索引中添加工具和烟雾火焰实体条目 - 完善力场类型的详细说明和使用示例
添加求解器、边界条件、耦合器、状态管理等核心组件的API参考文档，包括： 1. 6种求解器（刚体、PBD、MPM、FEM、SPH、混合）的详细说明 2. 4种边界条件（基础、刚性、粒子、流体）的接口文档 3. 5种耦合器（基础、SAP、MPM-PBD、MPM-SPH、FEM-刚性）的实现细节 4. 状态管理系统（基础、实体、求解器、场景状态）的API参考 5. 工具实体和混合材质的特殊实现说明 文档包含每个组件的功能说明、主要属性方法、继承关系和使用示例
实现一个Python代理工具，用于加载和处理API参考文档，提供交互式查询接口
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
20 participants
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.
对api进行了完善，请确认格式是否正确