Skip to content

docs(P4): update README.md with S3DIS experiments and remove UTF-8 characters - #10

Merged
DsThakurRawat merged 1 commit into
mainfrom
phase-4-readme-update
Jul 10, 2026
Merged

docs(P4): update README.md with S3DIS experiments and remove UTF-8 characters#10
DsThakurRawat merged 1 commit into
mainfrom
phase-4-readme-update

Conversation

@DsThakurRawat

@DsThakurRawat DsThakurRawat commented Jul 10, 2026

Copy link
Copy Markdown
Owner

Updates README.md to remove all UTF-8/emoji characters (ensuring 100% ASCII) and documents the Phase 4 S3DIS evaluation/experiment results.

Summary by CodeRabbit

  • Documentation
    • Refined the README’s tagline, headings, and Quickstart/Installation labels for consistency.
    • Added a link to experimental documentation.
    • Improved the Visual Results presentation.
    • Expanded evaluation details with model benchmarks, RGB ablation results, and label-efficiency findings.
    • Reformatted technical outputs, testing information, and author details for improved readability.

@beetle-ai

beetle-ai Bot commented Jul 10, 2026

Copy link
Copy Markdown

Important

Review skipped

You've hit the daily PR analysis limit on your current plan. Consider upgrading: Upgrade

⚙️ Settings

Severity Threshold: Medium — Balanced feedback — medium and high severity issues only.Change in Settings
Custom Rules: Define your own review rules — Set Custom Rules
PR Summary: Configure PR summary — Change in Settings

📖 User Guide
  • Once repos are connected, PR analysis is automatically enabled. You can disable analysis for this repo from beetleai.dev/analysis
  • Comment @beetle on any PR to start analysis manually
  • Comment @beetle stop to stop any ongoing analysis

Follow us: Beetle · X · LinkedIn

@DsThakurRawat
DsThakurRawat merged commit fcc7a47 into main Jul 10, 2026
4 checks passed
@DsThakurRawat
DsThakurRawat deleted the phase-4-readme-update branch July 10, 2026 15:43
@coderabbitai

coderabbitai Bot commented Jul 10, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: cc0bc087-1c86-4f87-b696-9f38a4be3b91

📥 Commits

Reviewing files that changed from the base of the PR and between d233004 and f465f2e.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

README.md was reformatted with neutral headings, expanded documentation navigation, reorganized visual results, and added detailed S3DIS benchmark, ablation, and label-efficiency results.

Changes

README Documentation Refresh

Layer / File(s) Summary
README structure and navigation
README.md
The tagline, section headings, documentation links, and visual-results layout were revised for consistent presentation.
Evaluation and results content
README.md
S3DIS benchmark, RGB ablation, label-efficiency, technical output, testing, and author sections were expanded or reformatted.

Estimated code review effort: 2 (Simple) | ~10 minutes

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch phase-4-readme-update

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the README.md file by removing emojis from headers, updating formatting, and adding a comprehensive section on S3DIS Area-5 evaluation results, including model benchmarks, an RGB ablation study, and a label efficiency study. The review feedback suggests improving usability by converting inline image paths to clickable markdown links and fixing a minor capitalization inconsistency ("Labeled" to "labeled").

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread README.md
| hybrid | 0.2749 | 0.6582 |
| hybrid_v2 | 0.2986 | 0.6636 |

Detailed per-class IoU results are documented in [docs/EXPERIMENTS.md](docs/EXPERIMENTS.md). A visualization of the per-class IoU bar chart can be found at `docs/images/per_class_iou.png`.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Consider converting the inline code path to a clickable markdown link so that readers can easily navigate to the visualization on GitHub.

Suggested change
Detailed per-class IoU results are documented in [docs/EXPERIMENTS.md](docs/EXPERIMENTS.md). A visualization of the per-class IoU bar chart can be found at `docs/images/per_class_iou.png`.
Detailed per-class IoU results are documented in [docs/EXPERIMENTS.md](docs/EXPERIMENTS.md). A visualization of the per-class IoU bar chart can be found at [docs/images/per_class_iou.png](docs/images/per_class_iou.png).

Comment thread README.md
- **20 rooms**: mIoU 0.2561
- **40 rooms**: mIoU 0.2558

The learning curve plot is located at `docs/images/label_efficiency.png`.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Consider converting the inline code path to a clickable markdown link so that readers can easily navigate to the learning curve plot on GitHub.

Suggested change
The learning curve plot is located at `docs/images/label_efficiency.png`.
The learning curve plot is located at [docs/images/label_efficiency.png](docs/images/label_efficiency.png).

Comment thread README.md
Every run produces a standard artifacts bundle in the `outputs/` directory:

- **`segmented_room.ply`**: Fully labeled 3D point cloud.
- **`segmented_room.ply`**: Fully Labeled 3D point cloud.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For consistency with the other bullet points in this section, the word 'Labeled' should be lowercase ('labeled').

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant