Commit 99b755a
authored
docs(readme): show Patchwork++ as ROS 2 default + advertise SemanticKITTI eval harness (#98)
* docs(readme): show Patchwork++ as the ROS 2 default + advertise eval harness
ROS 2 section:
- Make explicit that `ros2 launch patchworkpp patchworkpp.launch.py`
alone runs Patchwork++; only `algorithm:=patchwork` opts into the
classic algorithm. The launch file's LaunchConfiguration default is
already "patchworkpp" (ros/launch/patchworkpp.launch.py:20), so this
is a doc fix, not a behavioural change.
What's-in-this-repo:
- Add a bullet for python/examples/evaluate_semantickitti.py and note
that the two algorithms use different SemanticKITTI evaluation
protocols (Patchwork paper counts low-z vegetation as ground;
Patchwork++ paper Sec. IV.A excludes vegetation entirely because
the SemanticKITTI `vegetation` label mixes spurious leaves /
branches with low ground cover). Point at USAGE.md §1 and §4 for
the protocol switch and per-sequence numbers.
Docs-only; no version bump.
* docs(readme): pip-first Python install, demote make pyinstall to a contributors note
pypatchworkpp ships on PyPI since v1.3.0; the pip banner is already
at the top of the README, but the Python install section was still
making `make pyinstall` the headline command. Switch the order:
- Lead with `pip install pypatchworkpp` and `pip install 'pypatchworkpp[demo]'`
(the `[demo]` extra is defined in python/pyproject.toml and pulls
open3d).
- Keep `make pyinstall` / `make pyinstall_with_demo` in a collapsed
<details> block labelled "Build from source (contributors /
unreleased main)" so the source-build path is still discoverable
without competing with the pip path for new users.
Docs-only; same PR as the ROS 2 default clarification + eval-harness
bullet.
* docs: move vegetation-protocol rationale out of README into USAGE.md §1
The README "What's in this repo" bullet was carrying a 4-line wall of
text about why Patchwork and Patchwork++ disagree on the vegetation
class. Shrink it to a single sentence + link to USAGE.md §1, and put
the full rationale (low ground cover vs. overhead foliage, why the
two papers chose different resolutions) where it belongs.
* Finally update README.md1 parent 26b4c01 commit 99b755a
2 files changed
Lines changed: 25 additions & 9 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
41 | 41 | | |
42 | 42 | | |
43 | 43 | | |
| 44 | + | |
44 | 45 | | |
45 | 46 | | |
46 | 47 | | |
| |||
68 | 69 | | |
69 | 70 | | |
70 | 71 | | |
71 | | - | |
| 72 | + | |
72 | 73 | | |
73 | 74 | | |
74 | | - | |
| 75 | + | |
| 76 | + | |
75 | 77 | | |
76 | 78 | | |
77 | | - | |
78 | | - | |
79 | | - | |
| 79 | + | |
80 | 80 | | |
81 | | - | |
| 81 | + | |
82 | 82 | | |
83 | 83 | | |
84 | | - | |
| 84 | + | |
| 85 | + | |
85 | 86 | | |
86 | 87 | | |
87 | | - | |
| 88 | + | |
88 | 89 | | |
89 | 90 | | |
90 | 91 | | |
| |||
135 | 136 | | |
136 | 137 | | |
137 | 138 | | |
138 | | - | |
| 139 | + | |
139 | 140 | | |
140 | 141 | | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
141 | 146 | | |
142 | 147 | | |
143 | 148 | | |
| |||
193 | 198 | | |
194 | 199 | | |
195 | 200 | | |
| 201 | + | |
196 | 202 | | |
197 | 203 | | |
198 | 204 | | |
| |||
203 | 209 | | |
204 | 210 | | |
205 | 211 | | |
| 212 | + | |
206 | 213 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
17 | 26 | | |
18 | 27 | | |
19 | 28 | | |
| |||
0 commit comments