Skip to content

Commit ec13257

Browse files
WCJ-BERTWCJ-BERT
committed
Initial release of WorldEngine
0 parents  commit ec13257

430 files changed

Lines changed: 735856 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/FUNDING.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# These are supported funding model platforms
2+
3+
github: [OpenDriveLab] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
4+
patreon: # Replace with a single Patreon username
5+
open_collective: # Replace with a single Open Collective username
6+
ko_fi: # Replace with a single Ko-fi username
7+
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9+
liberapay: # Replace with a single Liberapay username
10+
issuehunt: # Replace with a single IssueHunt username
11+
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
12+
polar: # Replace with a single Polar username
13+
buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
14+
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Bug Description
10+
11+
A clear and concise description of what the bug is.
12+
13+
## To Reproduce
14+
15+
Steps to reproduce the behavior:
16+
1. Go to '...'
17+
2. Run command '...'
18+
3. See error
19+
20+
## Expected Behavior
21+
22+
A clear and concise description of what you expected to happen.
23+
24+
## Actual Behavior
25+
26+
What actually happened, including any error messages or stack traces.
27+
28+
```
29+
Paste error messages or stack traces here
30+
```
31+
32+
## Environment
33+
34+
**System Information:**
35+
- OS: [e.g., Ubuntu 22.04]
36+
- Python version: [e.g., 3.9.0]
37+
- PyTorch version: [e.g., 2.0.1]
38+
- CUDA version: [e.g., 11.8]
39+
- GPU model: [e.g., NVIDIA RTX 4090]
40+
41+
**WorldEngine:**
42+
- Version/Commit: [e.g., v0.1.0 or commit hash]
43+
- Component: [e.g., SimEngine, AlgEngine]
44+
45+
**Installation Method:**
46+
- [ ] Installed via scripts/install_simengine.sh
47+
- [ ] Installed via scripts/install_algengine.sh
48+
- [ ] Manual installation
49+
- [ ] Other: [please specify]
50+
51+
## Additional Context
52+
53+
Add any other context about the problem here. For example:
54+
- Does this happen consistently or intermittently?
55+
- Have you made any modifications to the code?
56+
- Are there any specific configurations or parameters being used?
57+
58+
## Screenshots
59+
60+
If applicable, add screenshots to help explain your problem.
61+
62+
## Possible Solution
63+
64+
If you have any ideas on how to solve the issue, please share them here.
65+
66+
## Checklist
67+
68+
- [ ] I have checked the [FAQ](https://github.com/OpenDriveLab/WorldEngine#-faq) and [existing issues](https://github.com/OpenDriveLab/WorldEngine/issues)
69+
- [ ] I have provided all the information requested above
70+
- [ ] I have tested with the latest version of WorldEngine
71+
- [ ] This is a minimal reproducible example (if applicable)

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Feature Description
10+
11+
A clear and concise description of the feature you'd like to see.
12+
13+
## Motivation
14+
15+
**Is your feature request related to a problem? Please describe.**
16+
17+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
18+
19+
**Why is this feature important?**
20+
21+
Explain the value this feature would bring to the project and its users.
22+
23+
## Proposed Solution
24+
25+
**Describe the solution you'd like**
26+
27+
A clear and concise description of what you want to happen.
28+
29+
**How would this feature work?**
30+
31+
Provide technical details if possible:
32+
- API changes
33+
- New classes/functions
34+
- Configuration options
35+
- Example usage
36+
37+
```python
38+
# Example code showing how the feature would be used
39+
```
40+
41+
## Alternatives Considered
42+
43+
**Describe alternatives you've considered**
44+
45+
A clear and concise description of any alternative solutions or features you've considered and why they weren't suitable.
46+
47+
## Additional Context
48+
49+
Add any other context, screenshots, or examples about the feature request here.
50+
51+
**Use Cases:**
52+
53+
Describe specific scenarios where this feature would be useful:
54+
1. Use case 1: ...
55+
2. Use case 2: ...
56+
57+
**Related Work:**
58+
59+
Are there similar features in other projects that could serve as inspiration?
60+
- Project/Paper: [link]
61+
- How it relates: ...
62+
63+
## Implementation Considerations
64+
65+
**Potential Challenges:**
66+
67+
What challenges might arise when implementing this feature?
68+
- Challenge 1: ...
69+
- Challenge 2: ...
70+
71+
**Breaking Changes:**
72+
73+
Would this feature introduce any breaking changes to the existing API?
74+
- [ ] Yes (please describe)
75+
- [ ] No
76+
77+
**Performance Impact:**
78+
79+
Would this feature have any impact on performance?
80+
- [ ] Yes (please describe expected impact)
81+
- [ ] No
82+
- [ ] Unknown
83+
84+
## Willingness to Contribute
85+
86+
- [ ] I am willing to implement this feature and submit a PR
87+
- [ ] I am willing to help test this feature
88+
- [ ] I can provide additional details if needed
89+
90+
## Checklist
91+
92+
- [ ] I have checked [existing issues](https://github.com/OpenDriveLab/WorldEngine/issues) to ensure this feature hasn't been requested before
93+
- [ ] I have read the [Contributing Guidelines](https://github.com/OpenDriveLab/WorldEngine/blob/main/CONTRIBUTING.md)
94+
- [ ] I have provided a clear description of the feature and its motivation

‎.github/pull_request_template.md‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
# Pull Request
2+
3+
## Description
4+
5+
<!-- Provide a brief description of the changes in this PR -->
6+
7+
## Type of Change
8+
9+
Please check the option that best describes this PR:
10+
11+
- [ ] Bug fix (non-breaking change which fixes an issue)
12+
- [ ] New feature (non-breaking change which adds functionality)
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14+
- [ ] Documentation update
15+
- [ ] Code refactoring (no functional changes)
16+
- [ ] Performance improvement
17+
- [ ] Test additions or updates
18+
- [ ] Other (please describe):
19+
20+
## Related Issues
21+
22+
<!-- Link to related issues using #issue_number -->
23+
24+
Fixes #
25+
Relates to #
26+
27+
## Motivation and Context
28+
29+
<!-- Why is this change required? What problem does it solve? -->
30+
31+
## Changes Made
32+
33+
<!-- Provide a detailed list of changes -->
34+
35+
- Change 1
36+
- Change 2
37+
- Change 3
38+
39+
## Testing
40+
41+
### Test Configuration
42+
43+
- OS: [e.g., Ubuntu 22.04]
44+
- Python version: [e.g., 3.9.0]
45+
- PyTorch version: [e.g., 2.0.1]
46+
- CUDA version: [e.g., 11.8]
47+
- GPU model: [e.g., NVIDIA RTX 4090]
48+
49+
### Tests Performed
50+
51+
<!-- Describe the tests you ran to verify your changes -->
52+
53+
- [ ] Ran scripts/closed_loop_test.sh successfully
54+
- [ ] Ran scripts/multigpu_closed_loop_test.sh successfully (if applicable)
55+
- [ ] Added new unit tests
56+
- [ ] All existing tests pass
57+
- [ ] Manual testing performed
58+
59+
### Test Results
60+
61+
<!-- Provide test results, logs, or screenshots if applicable -->
62+
63+
```
64+
Paste relevant test output here
65+
```
66+
67+
## Performance Impact
68+
69+
<!-- If applicable, describe any performance implications -->
70+
71+
- [ ] No performance impact
72+
- [ ] Performance improved (please describe)
73+
- [ ] Performance may be affected (please describe)
74+
- [ ] Performance testing not applicable
75+
76+
## Screenshots (if applicable)
77+
78+
<!-- Add screenshots to demonstrate visual changes -->
79+
80+
## Documentation
81+
82+
- [ ] Documentation has been updated (if needed)
83+
- [ ] Code comments added/updated (if needed)
84+
- [ ] CHANGELOG.md updated
85+
- [ ] README.md updated (if needed)
86+
87+
## Code Quality
88+
89+
- [ ] My code follows the project's style guidelines
90+
- [ ] I have performed a self-review of my code
91+
- [ ] I have commented my code, particularly in hard-to-understand areas
92+
- [ ] My changes generate no new warnings
93+
- [ ] I have added tests that prove my fix is effective or that my feature works
94+
- [ ] New and existing unit tests pass locally with my changes
95+
96+
## Breaking Changes
97+
98+
<!-- If this PR includes breaking changes, describe them and provide migration instructions -->
99+
100+
- [ ] This PR introduces breaking changes
101+
- Breaking change 1: ...
102+
- Migration path: ...
103+
104+
## Dependencies
105+
106+
<!-- List any new dependencies added or version changes -->
107+
108+
- [ ] This PR adds new dependencies
109+
- Dependency name and version:
110+
- Reason for adding:
111+
112+
## Checklist
113+
114+
- [ ] I have read the [Contributing Guidelines](https://github.com/OpenDriveLab/WorldEngine/blob/main/CONTRIBUTING.md)
115+
- [ ] I have read the [Code of Conduct](https://github.com/OpenDriveLab/WorldEngine/blob/main/CODE_OF_CONDUCT.md)
116+
- [ ] My commits follow the project's commit message conventions
117+
- [ ] I have rebased my branch on the latest main branch
118+
- [ ] I have resolved all merge conflicts
119+
- [ ] I am willing to make changes based on reviewer feedback
120+
121+
## Additional Notes
122+
123+
<!-- Any additional information that reviewers should know -->
124+
125+
## Reviewer Checklist (for maintainers)
126+
127+
- [ ] Code quality and style
128+
- [ ] Test coverage
129+
- [ ] Documentation completeness
130+
- [ ] Performance considerations
131+
- [ ] Security implications
132+
- [ ] Breaking changes properly documented
133+
- [ ] CHANGELOG.md updated

0 commit comments

Comments
 (0)