KOKIAOKI / 3d_bbs

MIT License
172 stars 28 forks source link

add submodule eigen #29

Closed KOKIAOKI closed 4 months ago

KOKIAOKI commented 5 months ago

Because eigen3.3.X has bug in the matrix calculation on CUDA kernel, I added eigen3.4.X in thirdparty/Eigen as submodule. This is optional.

coderabbitai[bot] commented 5 months ago

Walkthrough

The project has evolved significantly to boost performance and streamline dependencies. Key changes include integrating the Eigen library as an optional component, enhancing CMake logic for OpenMP and CUDA detection, and refining build instructions. These updates aim to optimize processing efficiency and enhance development workflows.

Changes

Files Change Summary
CMakeLists.txt Added logic for optional inclusion of Eigen library, finding OpenMP and CUDA, and updated include paths.
README.md Updated for faster processing, adjusted dependencies, renamed performance section, and revised build instructions.

🐇✨
Amidst the code's dance, changes take flight,
A rabbit weaves through, with skills so bright.
Eigen joins the party, matrices align,
OpenMP and CUDA, in harmony combine.
Faster builds, smoother paths we find,
In this digital realm, where progress entwined.
Hop along, dear code, towards the unknown,
Together we journey, seeds of innovation sown.
✨🐇


Recent Review Details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between bcea017b9ef6caa393365e19ac7d164e6e546696 and 809035a7f1d22c481a5592be953d1d557e0b6a22.
Files selected for processing (2) * CMakeLists.txt (2 hunks) * README.md (2 hunks)
Additional Context Used
LanguageTool (17)
README.md (17)
Near line 1: Did you mean “3D”(= three-dimensional) or “3rd” (= third)? Context: # 3d_bbs Fast and accurate 3D global localiz... --- Near line 1: Possible spelling mistake found. Context: # 3d_bbs Fast and accurate 3D global localizatio... --- Near line 9: Possible spelling mistake found. Context: ...g times are as follows: - Hierarchical voxelmap construction - Paper: 9,272 ms on ave... --- Near line 12: Possible spelling mistake found. Context: ...**: 3,494 ms on average - **Use saved voxelmap**: 130 ms on average - Global localizat... --- Near line 18: Possible typo detected. Context: ...89 ms** on average ## Dependencies - bbs3d (Lower versions are not tested) - CMa... --- Near line 21: Possible spelling mistake found. Context: ... CMake - Eigen3 (3.4.0 or higher) - OpenMP - CUDA (12.0 or higher) - test - (A... --- Near line 22: Possible spelling mistake found. Context: ...Eigen3 (3.4.0 or higher) - OpenMP - CUDA (12.0 or higher) - test - (All bbs3d ... --- Near line 24: Possible typo detected. Context: ...- CUDA (12.0 or higher) - test - (All bbs3d dependencies) - PCL - ros2 test - (... --- Near line 27: Possible typo detected. Context: ...endencies) - PCL - ros2 test - (All bbs3d dependencies) - ros2 humble ### Supp... --- Near line 32: Possible spelling mistake found. Context: ...ros2 humble ### Support Docker 🐳 If nvidia driver is 525.60.11 or higher, try dock... --- Near line 33: Unpaired symbol: ‘]’ seems to be missing Context: ...! For more information, you can check [docker_start.md](./docker/docker_start.m... --- Near line 35: Possible spelling mistake found. Context: ....md](./docker/docker_start.md) ## 3d_bbs core source code ### Build and Install ... --- Near line 45: Possible spelling mistake found. Context: ..., git clone with ``--recursive`` - CPU ver. & GPU ver. (Please ignore the large nu... --- Near line 45: Possible spelling mistake found. Context: ... with ``--recursive`` - CPU ver. & GPU ver. (Please ignore the large number of war... --- Near line 52: Possible spelling mistake found. Context: ...se make -j sudo make install ``` - CPU ver. only ```shell script cmake .. -DCMAKE_... --- Near line 52: This sentence does not start with an uppercase letter. Context: ...ke -j sudo make install ``` - CPU ver. only ```shell script cmake .. -DCMAKE_BUILD_... --- Near line 60: Unpaired symbol: ‘]’ seems to be missing Context: ...sudo make install ``` ## Test code See [test_code.md](./test/test_code.md)
Additional comments not posted (7)
CMakeLists.txt (4)
`15-19`: Configuration for OpenMP is correctly set up. --- Line range hint `22-26`: CUDA configuration is correctly set up. --- `31-35`: Conditional inclusion of Eigen directories is correctly handled. --- Line range hint `36-55`: Build and installation process for CPU and GPU versions is correctly set up.
README.md (3)
`9-13`: Updated processing times provide clear and useful performance metrics. --- `19-22`: Updated dependencies section correctly reflects the new setup requirements. --- `43-55`: Build and install instructions are clear and include necessary steps for different configurations.
--- Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.