Skip to content

Latest commit

 

History

History
530 lines (464 loc) · 43.1 KB

CHANGELOG.md

File metadata and controls

530 lines (464 loc) · 43.1 KB

Rerun changelog

0.5.1 - Patch Release - 2023-05-01

Overview & Highlights

This Release fixes a few small bugs on top of the v0.5.0 release.

In Detail

  • Bump hyper version due to RUSTSEC-2023-0034 #1951
  • Round to nearest color_index when doing color mapping #1969
  • Use an sRGB-correct gray gradient when displaying grayscale images #2014
  • Don't use console.error #1984
  • Fix failure to save files when split table contains no data #2007

0.5.0 - Jupyter MVP, GPU-based picking & colormapping, new datastore!

Overview & Highlights

This new release adds MVP support for embedding Rerun in Jupyter notebooks, and brings significant performance improvements across all layers of the stack.

  • Rerun can now be embedded in Jupyter notebooks
    • Tested with Jupyter Notebook Classic, Jupyter Lab, VSCode & Google Colab; checkout our How-to guide
    • Try it out live on Google Colab
  • All colormapping tasks are now done directly on the GPU
    • This yields very significant performance improvements for colormapping heavy workload (e.g. segmentation)
    • Try it out in our new segment_anything example that shows off the latest models from Meta AI
  • GPU picking & hovering now works with all of our primitives, including meshes & depth clouds
    • This fixes all the shortcomings of the previous CPU-based system
    • Rerun's automatic backprojection of depth textures ("depth clouds") is now feature complete
    • Try it out in our updated nyud example
  • Our datastore has been completely revamped to more closely match our latest data model
    • This yields very significant performance improvements for workloads with many events
    • Checkout this post for a detailed walkthrough of the changes

In Detail

🐍 Python SDK

  • Document that we also accept colors in 0-1 floats #1740
  • Don't initialize an SDK session if we are only going to be launching the app #1768
  • Allow torch tensors for log_rigid3 #1769
  • Always send recording_id as part of LogMsg #1778
  • New reset_time API #1826 #1854
  • Always flush when we remove a sink #1830
  • More robust wait for exit condition during .serve() #1939

🪳 Bug Fixes

  • Fix broken outlines (hover/select effect) for lines #1724
  • Fix logged obb being displayed with half of the requested size #1749 (thanks @BenjaminDev!)
  • Fix log_obb usage #1761
  • Always create the log_time timeline #1763
  • Fix undo/redo selection shortcut/action changing selection history without changing selection #1765
  • Fix various crashes #1780
  • Fix crash when trying to do picking on depth clouds d94ca3dd35e73e1984ccb969d0c7abd0d3e0faa9
  • ci: fix benchmarks #1799
  • ci: fix cargo deny #1806
  • Fix "too many points" crash #1822
  • Allow re-use of RowIds if no conflict is possible #1832
  • Reduce memory used by staging belts on Web #1836
  • Test and handle all tensor dtypes as images #1840
  • Fix the python build when running without web_viewer enabled #1856
  • Error instead of expect inside msg_encode #1857
  • Fix shutdown race condition in re_sdk_comms client #1861
  • Fix broken instance picking in presence of images #1876
  • Make sure JPEGs are always decoded #1884
  • Fix crash when saving store to file #1909
  • Don't clean up LogDbs that only contain a BeginRecordingMsg #1914
  • Fix picking entities with image + another object (or label) twice #1908
  • Fix double clicking camera no longer focusing on said camera #1911
  • Fix annotation images sometimes drawn in the background #1933
  • Use zipfile python library instead of unzip command in arkitscene demo #1936
  • Fix backslashes in arkitscene rigid transformation path #1938
  • Fix hover/select highlights when picking single points in a scene with multiple point clouds #1942
  • Fix hovering depth clouds #1943

🚀 Performance Improvements

  • batching 4: retire MsgBundle + batching support in transport layer #1679
  • Optimize the depth-cloud shader when depth=0 #1729
  • arrow2_convert primitive (de)serialization benchmarks #1742
  • arrow2 estimated_bytes_size benchmarks #1743
  • arrow2 erased refcounted clones benchmarks #1745
  • benchmarks for common vector ops across smallvec/tinyvec/std #1747
  • Columnar TimePoints in data tables and during transport #1767
  • Compile with panic = "abort" #1813
  • Process 2D points per entities like 3D points #1820
  • re_query: use latest data types (DataRow/DataCell) #1828
  • Depth cloud textures are now cached frame-to-frame #1913

🧑‍🏫 Examples

  • Add new ARKitScenes example #1538 (thanks @pablovela5620!)
  • New example code for Facebook research's segment-anything #1788
  • Add minimal_options example for Rust SDK #1773 (thanks @h3mosphere!)
  • Remove manual depth projection from car and nyud examples #1869
  • Always spawn instead of fork in multiprocessing example #1922
  • Add --num-frames arg to canny (webcam) example #1923
  • Add argument parsing to rerun_demo #1925
  • Join threads at end of multithreading example #1934

📚 Docs

  • Add typing_extensions to requirements-doc.txt #1786
  • Fix typos in notebook readme #1852
  • Update docs related to notebook #1915

🖼 UI Improvements

  • Hover rays for tracked 3D cameras #1751
  • Collapse space-view by default if there is only one child #1762
  • Option to show scene bounding box #1770
  • Assign default colors to class-ids when annotation context is missing #1783
  • Add Restart command and keyboard shortcut for moving time to start of timeline #1802 (thanks @h3mosphere!)
  • New option to disable persistent storage #1825
  • Show previews of colormaps when selecting them #1846
  • Smooth out scroll wheel input for camera zooming #1920

🤷‍♂️ Other Viewer Improvements

  • Change EntityPathHash to be 64 bit #1723
  • Central GpuReadback handling for re_viewer, experimental space view screenshots #1717
  • Readback depth from GPU picking #1752
  • Use GPU picking for points, streamline/share picking code some more #1814
  • Use GPU picking for line(like) primitives, fix interactive flags #1829
  • Use GPU colormapping when showing images in the GUI #1865

🕸️ Web

  • Make CI publish latest tagged web-viewer to app.rerun.io #1725
  • Implement re_tuid::Tuid::random() on web #1796
  • Refactor the relationship between the assorted web / websocket servers #1844
  • Notebooks: make presentation_id consistent and use data-attribute for rrd #1881
  • 2.5GB before GC kick in on web #1944

🎨 Renderer Improvements

  • GPU based picking with points #1721
  • improved renderer label handling #1731
  • Improved readback data handling #1734
  • GPU based mesh picking #1737
  • Improve dealing with raw buffers for texture read/write #1744
  • GPU colormapping, first step #1835
  • GPU tensor colormapping #1841
  • GPU picking for depth clouds #1849
  • Implement billinear filtering of textures #1850 #1859 #1860
  • Refactor: remove GpuTexture2DHandle::invalid #1866
  • Fix filtering artifact for non-color images #1886
  • Refactor: Add helper functions to GpuTexture2DHandle #1900

🛢 Datastore Improvements

  • Datastore: revamp bench suite #1733
  • Datastore revamp 1: new indexing model & core datastructures #1727
  • Datastore revamp 2: serialization & formatting #1735
  • Datastore revamp 3: efficient incremental stats #1739
  • Datastore revamp 4: sunset MsgId #1785
  • Datastore revamp 5: DataStore::to_data_tables() #1791
  • Datastore revamp 6: sunset LogMsg storage + save store to disk #1795
  • Datastore revamp 7: garbage collection #1801
  • Incremental metadata registry stats #1833

✨ Other Enhancement

🗣 Merged RFCs

  • RFC: datastore state of the union & end-to-end batching #1610

🧑‍💻 Dev-experience

  • Post-release cleanup #1726
  • Remove unnecessary dependencies #1711 (thanks @vsuryamurthy!)
  • Use copilot markers in PR template #1784
  • re_format: barebone support for custom formatting #1776
  • Refactor: Add new helper crate re_log_encoding #1772
  • setup_web.sh supports pacman package manager #1797 (thanks @urholaukkarinen!)
  • Add rerun --strict: crash if any warning or error is logged #1812
  • End-to-end testing of python logging -> store ingestion #1817
  • Fix e2e test on CI: Don't try to re-build rerun-sdk #1821
  • Install the rerun-sdk in CI using --no-index and split out linux wheel build to run first #1838
  • Remove more unused dependencies #1863
  • Improve end-to-end testing slightly #1862
  • Turn off benchmarks comment in each PR #1872
  • Fix double-negation in scripts/run_python_e2e_test.py #1896
  • Improve PR template with better comment, and no copilot by default #1901
  • Optimize generate_changelog.py #1912

🤷‍♂️ Other

0.4.0 - Outlines, web viewer and performance improvements

release.0.4.0.mp4

Overview & Highlights

  • Add support for mesh vertex colors #1671
  • Lower memory use #1535
  • Improve garbage collection #1560
  • Improve the web viewer #1596 #1594 #1682 #1716
  • Nice outlines when hovering/selecting
  • Add an example of forever-streaming a web-camera image to Rerun #1502
  • Fix crash-on-save on some versions of Linux #1402
  • And a lot of other bug fixes
  • Many performance improvements

We now host an experimental and unpolished web-viewer at https://app.rerun.io/ for anyone to try out!

In Detail

🐍 Python SDK

  • Expose all Rerun enums and types to main module scope #1598
  • Make log_point more forgiving and update docstring #1663
  • Add support for mesh vertex colors #1671

🦀 Rust SDK

  • ⚠️ Session::new has been replaced with SessionBuilder #1528
  • ⚠️ session.spawn(…) -> rerun::native_viewer::spawn(session, …) #1507
  • ⚠️ session.show() -> rerun::native_viewer::show(session) #1507
  • ⚠️ session.serve(…) -> rerun::serve_web_viewer(session, …); #1507
  • ⚠️ rerun::global_session is now hidden behind the global_session feature flag #1507
  • Add support for mesh vertex colors #1671

🪳 Bug Fixes

  • datastore: disable compaction (fixes 2x memory issue) #1535
  • Fix garbage collection #1560
  • Avoid using undefined extern "C" on windows #1577
  • Fix crash on decoding old .rrd files #1579
  • datastore: stabilize dataframe sorts #1549
  • Stop using infinities in wgsl shaders #1594
  • Workaround for alpha to coverage state leaking on (Web)GL renderer #1596
  • Use a patched wasm-bindgen-cli with fix for 2GiB bug #1605
  • Misc: make example in log_pinhole runable #1609 (thanks @Sjouks!)
  • Early-out on zero-sized space-views to prevent crashes #1623
  • Print our own callstack on panics #1622
  • Handle ctrl+c to gracefully shutdown the server(s) #1613
  • Fix crash on serve exit, second attempt #1633
  • Fix wrong remove-tooltip for entities and groups #1637
  • Fix requiring requiring focus for shutdown via ctrl+c when starting viewer from command line #1646
  • Fix eye spin after eye reset #1652
  • Fix crash on negative radii by instead warning #1654
  • Fix crash when trying to listen on a taken TCP port #1650
  • Don't show 2D labels in 3D space views. #1641
  • Fix Z fighting with improved depth offset math #1661
  • Whether a spatial view is 2d or 3d is now reevaluated over time unless picked explicitly #1660
  • Update wgpu to v0.15.3, fixing meshes on Windows Chrome #1682
  • Fix a bug in the image hover code, causing the wrong RGBA values to be printed #1690
  • Fix a bug that caused points to be render too large #1690
  • Fix web crash on missing uniform buffer padding #1699
  • Fix memory_usage example relying on implicit recursive features #1709
  • Track changed state in nav mode combo box #1703
  • Fix crash-on-save by switching file-picker dialog to xdg-portal #1402
  • Change roll-shortcut from ALT to SHIFT #1715
  • Fix CpuWriteGpuReadBelt producing unaligned gpu buffer offsets #1716
  • Fix arrows requiring a radius to be visible #1720

🚀 Performance Improvements

  • Add re_arrow_store profile scopes #1546
  • datastore: early exit missing components at table level #1554
  • datastore: track bucket count in store stats & mem panel #1555
  • LogDb: dont split on index bucket size #1558
  • Introduce a simpler cache dedicated to just decode JPEGs #1550
  • Implement outlines for points 2d/3d/depth & use them for select & hover in Viewer #1568
  • Simplify ImageCache #1551
  • New time panel density graph #1557
  • Refactor the Arrow Mesh3D type to use zero-copy Buffers #1691
  • Remove the redundant costly transform check during categorization #1695
  • batching 3: DataRow & DataTable + no bundles outside of transport #1673

🧑‍🏫 Examples

  • Very simple example streaming from an opencv camera #1502
  • Initial TurtleBot subscriber demo #1523

📚 Docs

  • Link to the Python SDK build instructions in rerun_py/README.md #1565

🖼 UI Improvements

  • Fix combining outline mask for selection & hover #1552
  • Implement outlines for rectangles & use them for select & hover of image primitives in Viewer #1559
  • Show log messages in egui toast notifications #1603
  • Adapt UI for smaller screens #1608
  • Nicer toast notifications #1621
  • Don't hover things in 2D/3D views if we are dragging something #1643
  • Allow rolling 3D camera with primary mouse button + alt modifier #1659
  • Name space views after the space and indicate duplicate names #1653
  • Add banner about mobile browsers being unsupported #1674
  • Improve ui for tensors and color map selection #1683
  • Only show the mobile OS warning banner on web #1685
  • Improve the depth backprojection feature #1690
  • Swap overlay order of selection & hover outlines #1705
  • Turn on depth cloud backprojection by default #1710
  • Add radius boost for depth clouds on outline #1713

🤷‍♂️ Other Viewer Improvements

  • Fix web feature name in error messages #1521
  • Use outlines for mesh selections instead of highlight colors #1540
  • Implement outlines for line renderer & use them for select & hover of "line-like" primitives in Viewer #1553
  • Load .rrd file over HTTP #1600
  • Revert "Handle ctrl+c to gracefully shutdown the server(s)" #1632
  • More eager GC, and remove --fast-math optimization for wasm #1656
  • Detect failure to install GUI log callback #1655
  • Warn when most of the RAM has been used up by Rerun #1651
  • Apply color maps to all types of depth tensors #1686
  • Size boosted outlines for points & lines, color & size tweaking #1667
  • Default point radius to 1.5 ui points #1706
  • When streaming an rrd from http: play it, don't follow it #1707

🕸️ Web

  • Use log as our log backend instead of tracing #1590
  • Turn on allocation tracker at run-time and for web #1591
  • Set correct MIME types in re_web_viewer_server #1602
  • Upload web viewer to a bucket #1606
  • Use hostname for default websocket address #1664
  • Upload the colmap rrd file to gcloud #1666
  • Show a warning by default on mobile browsers #1670
  • Add analytics to the hosted index.html #1675
  • Always upload latest prerelease to a dedicated prefix #1676
  • Allow url param override on app.rerun.io #1678
  • Show the git commit in the about section in pre-release builds #1677
  • Update the web icon #1688

🎨 Renderer Improvements

  • Outlines via masking & postprocessing in re_renderer #1532
  • Add missing profiling scopes in re_renderer #1567
  • Don't call wgpu::Device::poll on the web #1626
  • Merge final outline render into composite step in order to fix blending #1629
  • renderer: fix the groupby logic in mesh instancing #1657
  • Fix outlines being offset diagonally by about half a pixel #1668
  • Gpu readback belt for fast & easy data readback from gpu #1687
  • Make CpuWriteGpuReadBelt texture copies easier/less error prone #1689

✨ Other Enhancement

  • datastore: split out formatting & sanity checks in their own modules #1625
  • Add rerun --save: stream incoming log stream to an rrd file #1662
  • batching 1: introduce DataCell & retire ComponentBundle #1634
  • Data store batching 2: split out component traits #1636

📈 Analytics

  • Analytics: don't spam warning when there is an HTTP connection problem #1564
  • Analytics: Rename "location" to "file_line" in the "crash-panic" event #1575

🗣 Merged RFCs

  • RFC: component-datatype conversions #1595
  • RFC: pre-proposal for blueprint store #1582

🧑‍💻 Dev-experience

  • Update rayon #1541
  • Fix some 1.68 clippy lints #1569
  • Remove duplicated 'nix' crate #1479
  • Better MsgId format #1566
  • Lint vertical spacing in Rust code #1572
  • CI: Replace wasm_bindgen_check.sh with actually building the web-viewer #1604
  • Add --all-features to Rust Analyzer flags #1624
  • Run clippy for wasm, with own clippy.toml config file #1628
  • Update tokio v1.24.1 -> v1.26.0 #1635
  • Add a workflow input for running benchmarks manually #1698
  • Add missing } to fix rust workflow #1700
  • Fix lint.py #1719
  • Add a script that generates a changelog from recent PRs and their labels #1718

🤷‍♂️ Other

0.3.1 - Remove potentially sensitive analytics

Remove potentially sensitive analytics, including path to rerun source code on panics, and rerun branch name when building from source #1563

Overview & Highlights

After a successful launch a couple of weeks ago, we're back with our second release! With a few exceptions this release focuses on internal refactors & improving our processes. However, we think you'll enjoy these goodies that made it in nonetheless!

23-03-02_18.44.38.patched.mp4

You can now generate point clouds directly from depth textures and choose a wide variety of color maps. Check out this video on how to use it. This is a lot faster and more convenient than doing so manually in your own code Some caveats: Picking is not yet working and visible history may behave differently (related to #723)

Other highlights:

  • Viewer
    • Improved formatting of date-times in plots #1356
    • Labels for 3D objects have now a color can now be selected & hovered #1438
    • Scale factor is saved across sessions and more persistent between screens #1448
    • Showing tensors in the viewer is now faster
  • SDK
    • Python packages now work with Ubuntu-20.04 #1334
    • u8 segmentation stay u8 now (they converted to u16 before) #1376
    • 2D Line strips can now be logged directly #1430
    • Add a strict mode to the Python SDK where misuses of the API result in exceptions being raised.#1477
    • Fix disabling Python API through init not working #1517
  • General
    • We build now with fewer build dependencies (there is however still more work to do!). Notably, we previously used a version of the time crate which had a security issue (CVE-2020-26235), thanks @mpizenberg for helping out!
    • Print more information & troubleshooting info on crash

Meanwhile, we did a bunch of improvements to our manual. If you had trouble running Rerun so far, check our updated troubleshooting page (and as always, please open an issue if something doesn't work).

⚠️ BREAKING: old .rrd files no longer load ⚠️

In Detail

New Features

  • Generate point clouds directly from depth textures
    • re_renderer: implement depth cloud renderer #1415
    • Integrate depth clouds into Rerun #1421
    • CPU & GPU color maps #1484
    • Integrate GPU color maps into depth clouds #1486
  • Python SDK: Add strict mode #1477
  • OS independent Zoom factor & serialization thereof #1448
  • Labels for 3D objects have now a color can now be selected & hovered #1438
  • Add 2d support for linestrips #1430
  • Add signal handler on *nix with troubleshooting and stacktrace #1340
    • Point users to our troubleshooting page on panic #1338

Performance

  • Speed up conversions for color arrays in Python #1454
  • Speed up fixed-sized array iteration #1050
  • Speed up tensor handling by padding data through more directly
    • Direct conversion to dynamic image from Tensors #1455
    • Convert view_tensor to use the new native Tensors #1439
  • Add option to show performance metrics in the UI in release builds too #1444
  • Faster stable diffusion sample #1364
  • SDK: stream to disk with save feature #1405
  • re_renderer has now a direct CPU->GPU copy mechanism
    • CpuWriteGpuReadBelt for fast frame by frame memory transfers #1382
    • Uniform buffer utility using CpuWriteGpuReadBelt #1400
    • Use CpuWriteGpuReadBelt for mesh data gpu upload #1416

Small improvements & Bugfixes

  • UI
    • Add scroll-bars the "Add/Remove entities" window #1445
    • Unify the time formatting between the time panel and the plot #1369
    • Timeline
      • Fix precision issue when zooming in on the timeline #1370
      • Improve the gap-detector #1363
    • Better time axis on plot view #1356
    • Prevent wrap on 'Streams' text #1308
    • Update to eframe 0.21.3 with fix for web text input #1311
  • re_renderer
    • Fix crash due to always expecting Rgba8Unorm backbuffer on Web & Bgra8Unorm on native #1413
    • Allow controlling the graphics backend & power preference through standard wgpu env vars #1332
  • Heuristic for camera frustum length is now based on scene size #1433
  • Fix python type signature for tensor names #1443
  • Don't convert u8 segmentation images to u16 #1376
  • Docs (excluding the manual)
    • Improve the docs of connect and serve #1450
    • Update log_mesh and log_meshes docs. #1286
    • Add guidelines for adding dependencies in a PR #1431
    • Add a few more sections to CODE_STYLE.md #1365
    • Fixup for some doc links #1314
    • Document undocumented environment variables on help page. #1335
    • Link to SDK operating modes doc in both SDK #1330
  • More information in --version #1388
  • Remove already broken show method from Python SDK #1429
  • Analytics
    • Send analytics events with callstacks on panics and signals #1409
    • Put all analytics to one bucket #1390
    • add event for when we serve the web-viewer .wasm #1379
    • register SDK language and data source #1371
    • Refactor analytics #1368
  • Versioned log streams streams #1420
  • Fix path issues when running debug viewer within workspace #1341
  • Detailed errors for re_renderer include_file! #1339
  • Limit logging in web-viewer to warn in order to workaround a crash issue (and reduce log spam) 1514
  • Fix disabling API through init not working #1517

CI, Testing & Build improvements

  • Reduce build dependencies
    • Get rid of time 0.1.* dependency #1408
    • Remove unnecessary ordered-float #1461
    • Remove extraneous image features and dependencies #1425
    • Replace reqwest with ureq #1407
    • Remove derive_more dependency #1406
  • Use different artifact names for wasm/js in debug builds #1428
  • Separate mac wheels & trigger wheel build from ui #1499
  • Add spell checking to CI #1492
  • Repo size
    • Always create new orphaned branch for gh-pages #1490
    • GitHub Action to prevent large files #1478
  • Python
    • Remove the python job path filters #1452
    • Use ruff for our python lints #1378
    • Use python3 in the jobs that weren't tested in PR #1348
  • Testing
    • Add a test of memory use when logging a lot of big images #1372
  • Switch ci_docker to a container based on ubuntu 20.04 #1334
  • Release handling
    • Switch release action to ncipollo #1489
    • Fix our continuous pre-releases #1458
    • Delete the prerelease before creating the new one #1485
    • Set prerelease to true even for version-tagged CI job #1504
    • Let the release job take care of creating the tag #1501
    • Use cargo update -w instead of cargo check when prepping prerelease #1500
    • Use prerelease tag instead of latest and update pointer on prerelease #1481
    • Include date in pre-release version #1472
    • Switch pre-release action to ncipollo/release-action #1466
  • Disallow some methods and types via Clippy#1411

Other non-user-facing refactors

  • Fix: don't create a dummy LogDb when opening the Rerun Menu #1440
  • re_renderer
    • Draw Phases in preparation of executing Renderer several times on different targets #1419
      • Fix mesh creation failing to copy index data. #1473
      • do not silently drop draw phases #1471
    • Simplify bind group allocation call by passing pool collection object. #1459
    • Interior mutable buffer/texture/bindgroup pools #1374
    • Rename all instances of frame_maintenance to begin_frame #1360
    • Texture & buffer call now wgpu's destroy on removal from pool #1359
    • Arrow buffers as (optional) first-class citizen #1482
    • Log static re_renderer resource generation #1464
  • Internal log_text_entry_internal to break circular deps #1488
  • Delete ClassicTensor and cleanup #1456
  • Fix re_renderer file watcher watching the same file several times #1463
  • Analytics
    • More ergonomic API #1410
    • Streamlining host vs. recorder python/rust versions #1380
    • Fix workspace detection #1437
  • Introduce DeserializableComponent trait and high-level query_latest #1417

Full Changelog

0.2.0

First public release!