[core] Add support for dynamic chunks #2918

Alxiice · 2025-10-13T08:40:28Z

Description

This PR goal is to change chunk system to be able to work with graphs where nodes can have no specific size set.

Changes

Compute system

New levels have been added on the computation :
- extreme (that targets higher specs that what intensive does)
- script which is a mode for single-process simple process. It targets specific machines on the farm that have the ability to run multiple jobs in parallel so for simple jobs it should allow faster processing
Delayed chunks creation
- node
  - A _chunksCreated param has been added to check if the chunks have been correctly initialized
  - Now by default we use resetChunks when loading meshroom, that will create a list with a single chunk, and we can create chunks at any moment with _createChunks.
  - A new NodeStatusData has been added that tracks a nodeStatus file which is similar to the chunk statuses files but is specific to the node. This node status is used to get the cached range parametrization of the node so that we can retrieve it when possible with _createChunksFromCache.
- taskManager
  - The TaskThread and TaskManager have been modified to launch the chunk creation when the node compute starts

Submitters

Submitters have been moved to another package (TBD where...)
The BaseSubmitter API have been updated to allow more flexibility. A new BaseSubmittedJob exists and is used to track jobs that have been created. The goal is to use this as an interface to call actions on it (stop/pause/restart...)
A new bin/meshroom_createChunks script have been created, and handles the chunk creation and additional chunk tasks spooling
- Calls the chunk creation
- Checks if we can spool additioanl tasks
- If so, execute queue tasks that will compute the chunks
- If not, execute the chunks serially on the current process

Changes to the tractor API have been implemented here meshroomHub/mrSubmitters#1

Examples

codecov · 2025-10-13T08:41:21Z

Codecov Report

❌ Patch coverage is 51.55483% with 296 lines in your changes missing coverage. Please review.
✅ Project coverage is 78.91%. Comparing base (70458d8) to head (38211d6).
⚠️ Report is 46 commits behind head on develop.
✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
meshroom/core/node.py	55.55%	180 Missing ⚠️
meshroom/core/submitter.py	40.71%	83 Missing ⚠️
meshroom/core/graph.py	44.82%	16 Missing ⚠️
meshroom/core/desc/node.py	40.00%	15 Missing ⚠️
meshroom/core/__init__.py	0.00%	1 Missing ⚠️
meshroom/core/desc/computation.py	83.33%	1 Missing ⚠️

❌ Your patch status has failed because the patch coverage (51.55%) is below the target coverage (70.00%). You can increase the patch coverage or adjust the target coverage.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #2918      +/-   ##
===========================================
- Coverage    80.74%   78.91%   -1.83%     
===========================================
  Files           59       59              
  Lines         7853     8305     +452     
===========================================
+ Hits          6341     6554     +213     
- Misses        1512     1751     +239

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

cbentejac

Additional notes:

Let's say I compute a graph (for example, the photogrammetry template) in a given location. All my nodes have been successfully computed, the statuses are all set to "SUCCESS". Now let's say I do a "save as" on the graph I just computed and save it to a new location. The cache changes, so we expect all the nodes' status to be reset. For nodes that have dynamic chunks, the display of the status is not refreshed, and we end up with nodes that appear as computed, although they have lost all their status files.
Below is a screenshot of the photogrammetry graph that was computed and saved in a new location (the first branch was computed, the second was added from the template for the sake of comparison):

There are some unpredictable behaviours when performing actions that are allowed but probably shouldn't be. An example would be clicking on "stop task" for a task that is already done computing and is in "SUCCESS" state, while nodes are being computed later on in the graph. The UI allows to perform it, there is an info message saying that the task has been successfully stopped, and the node's status is updated to "STOPPED" in the task manager and Graph Editor; it does not enable the "resume job" button. This seems to cause the job on the farm to finish computing the current task and then pausing the rest of the job (to be verified).
I have noticed on several occasions that when clicking on buttons from the "JOB" tab, the info message that is sent contains the name of a node that is not part of the job at all (if all my submitted tasks are for NodeName_2, I may get a message about NodeName_1, which is not being computed at all).

meshroom/core/node.py

bin/meshroom_createChunks

meshroom/core/node.py

meshroom/ui/qml/GraphEditor/TaskManager.qml

cbentejac

Additional notes:

Let's say I compute a graph (for example, the photogrammetry template) in a given location. All my nodes have been successfully computed, the statuses are all set to "SUCCESS". Now let's say I do a "save as" on the graph I just computed and save it to a new location. The cache changes, so we expect all the nodes' status to be reset. For nodes that have dynamic chunks, the display of the status is not refreshed, and we end up with nodes that appear as computed, although they have lost all their status files.
Below is a screenshot of the photogrammetry graph that was computed and saved in a new location (the first branch was computed, the second was added from the template for the sake of comparison):

There are some unpredictable behaviours when performing actions that are allowed but probably shouldn't be. An example would be clicking on "stop task" for a task that is already done computing and is in "SUCCESS" state, while nodes are being computed later on in the graph. The UI allows to perform it, there is an info message saying that the task has been successfully stopped, and the node's status is updated to "STOPPED" in the task manager and Graph Editor; it does not enable the "resume job" button. This seems to cause the job on the farm to finish computing the current task and then pausing the rest of the job (to be verified).
I have noticed on several occasions that when clicking on buttons from the "JOB" tab, the info message that is sent contains the name of a node that is not part of the job at all (if all my submitted tasks are for NodeName_2, I may get a message about NodeName_1, which is not being computed at all).

Copilot

Pull request overview

This PR implements a significant architectural change to the Meshroom chunk computation system, allowing nodes to delay chunk creation until computation time. This enables support for nodes without predetermined sizes and adds enhanced job management capabilities for render farm submissions.

Key Changes:

Introduces delayed chunk evaluation with _chunksCreated flag and placeholder chunks for nodes with dynamic sizes
Adds new computation levels (EXTREME and SCRIPT) for better resource targeting
Implements NodeStatusData for tracking node-level status separate from chunk status
Introduces comprehensive job management API with BaseSubmittedJob interface and JobManager for controlling farm jobs
Creates new meshroom_createChunks script for handling chunk initialization during farm submission

Reviewed changes

Copilot reviewed 20 out of 22 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
`meshroom/ui/reconstruction.py`	Adds safety check for empty chunks list before connecting signals
`meshroom/ui/qml/Utils/Colors.qml`	Adds new color (`darkpurple`) and `INPUT` status color, plus `getNodeColor()` function
`meshroom/ui/qml/GraphEditor/TaskManager.qml`	Major UI overhaul with task/job toolbars and chunk selection support
`meshroom/ui/qml/GraphEditor/NodeEditor.qml`	Handles chunk visibility based on `chunksCreated` flag
`meshroom/ui/qml/GraphEditor/NodeChunks.qml`	Improves null safety for chunk model handling
`meshroom/ui/qml/GraphEditor/Node.qml`	Adds chunk placeholder display for nodes without created chunks
`meshroom/ui/qml/GraphEditor/GraphEditor.qml`	Adds context menu items for external job control (interrupt, retry)
`meshroom/ui/qml/GraphEditor/ChunksListView.qml`	Syncs chunk selection from reconstruction to list view
`meshroom/ui/qml/Controls/NodeActions.qml`	Enhances action buttons with retry and improved submit/stop states
`meshroom/ui/qml/Application.qml`	Makes submit button toggle between submit and interrupt based on execution state
`meshroom/ui/graph.py`	Refactors `ChunksMonitor` to `NodeStatusMonitor` for both node and chunk monitoring
`meshroom/core/taskManager.py`	Implements chunk creation in `TaskThread` with signal-based coordination
`meshroom/core/submitter.py`	Introduces new submitter API with `BaseSubmittedJob` and `JobManager`
`meshroom/core/node.py`	Separates node status (`NodeStatusData`) from chunk status (`ChunkStatusData`) and implements delayed chunk creation
`meshroom/core/graph.py`	Updates graph processing to handle nodes without initialized chunks
`meshroom/core/desc/node.py`	Adds `ExitCleanup` handler for subprocess management
`meshroom/core/desc/computation.py`	Adds `EXTREME` and `SCRIPT` computation levels
`meshroom/core/__init__.py`	Improves submitter loading error messages
`meshroom/__init__.py`	Adds `MeshroomExitStatus` enum for special exit codes
`bin/meshroom_createChunks`	New script for chunk creation and task spooling during farm submission
`bin/meshroom_compute`	Updates to handle nodes without created chunks and status checking
`.git-blame-ignore-revs`	Adds linting commits to ignore list

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

meshroom/__init__.py

meshroom/core/taskManager.py

meshroom/core/desc/computation.py

meshroom/core/taskManager.py

meshroom/core/node.py

meshroom/ui/qml/GraphEditor/TaskManager.qml

meshroom/ui/graph.py

Alxiice · 2025-12-09T14:34:33Z

meshroom/core/taskManager.py

                for node in nodesToProcess:
-                    node.destroyed.connect(lambda obj=None, name=node.name: self.onNodeDestroyed(obj, name))
-                    node.initStatusOnSubmit()  # update node status
+                    # TODO : Notify the node that there was an issue on submit


Alxiice · 2025-12-09T14:34:45Z

meshroom/core/graph.py

+        else:
            for node in nodesToProcess:
-                node.initStatusOnSubmit()  # update node status
+                # TODO : Notify the node that there was an issue on submit


meshroom/core/node.py

`nodeType` and `packageName` are already part of the node's status file, and there is thus no need to propagate them to the chunks'.

…Blocks in status files

`canBeStopped` and `canBeCanceled` only took into account nodes that were being run locally. As nodes that have been submitted externally (exclusively on a render farm, not in another instance of Meshroom) can now be stopped and canceled as well, they are considered in both methods.

When a job has been submitted, the state of the `Submit` button switches to `stoppable`. Clicking it in this state interrupts the node's computation on the farm.

… state

…chunk

`chunkPlaceholder` is a list model that is meant to contain a placeholder chunk for nodes that have dynamic chunks: prior to the chunks' creation, it is used to reflect the state of the node as a single chunk. In particular, this allows to reflect accurately the node's status while it is submitted but the chunks have not been created yet. The property is a list model as it allows it to be used as a model later on on the QML side.

`onGraphUpdated` updates the models for chunks, including the placeholder, which allows to have an up-to-date status for all the existing chunks as well as the placeholder one when a node's number of chunks hasn't been determined yet.

…unks from cache

Alxiice self-assigned this Oct 13, 2025

Alxiice added the feature new feature (proposed as PR or issue planned by dev) label Oct 13, 2025

Alxiice added this to the Meshroom 2026.1.0 milestone Oct 13, 2025

Alxiice force-pushed the dev/delayChunkEvaluation branch 2 times, most recently from 02bae2f to 15df47f Compare October 21, 2025 09:56

Alxiice changed the base branch from develop to dev/remove_submitters October 21, 2025 09:56

Alxiice requested review from cbentejac and fabiencastan October 28, 2025 08:45

cbentejac force-pushed the dev/remove_submitters branch from 4b47850 to 51cfd91 Compare November 4, 2025 14:10

Base automatically changed from dev/remove_submitters to develop November 4, 2025 16:24

cbentejac force-pushed the dev/delayChunkEvaluation branch from 15b7db5 to ecbcbed Compare November 4, 2025 16:36

cbentejac requested changes Nov 5, 2025

View reviewed changes

cbentejac force-pushed the dev/delayChunkEvaluation branch 4 times, most recently from 8a599b4 to e720c8b Compare November 24, 2025 17:04

cbentejac force-pushed the dev/delayChunkEvaluation branch 5 times, most recently from dede3a7 to 4f96f9d Compare December 1, 2025 16:19

cbentejac force-pushed the dev/delayChunkEvaluation branch from b371eef to 22ae573 Compare December 3, 2025 15:46

cbentejac requested a review from Copilot December 9, 2025 08:59

Copilot started reviewing on behalf of cbentejac December 9, 2025 08:59 View session

Copilot AI reviewed Dec 9, 2025

View reviewed changes

Alxiice commented Dec 9, 2025

View reviewed changes

meshroom/core/node.py Outdated Show resolved Hide resolved

cbentejac and others added 23 commits January 2, 2026 11:26

[core] Linting: Remove all trailing whitespaces

8be3021

[core] node: Remove references to packageVersion in NodeStatusData

f634d11

[core] node: Remove static info from the chunks' status file

2e0fea6

`nodeType` and `packageName` are already part of the node's status file, and there is thus no need to propagate them to the chunks'.

Linting: Remove trailing whitespaces

04a425d

[core] node: Use explicit keys for chunks' blockSize, fullSize and nb…

44c8584

…Blocks in status files

[ui] Add stoppable state for the Submit button

6ae0216

When a job has been submitted, the state of the `Submit` button switches to `stoppable`. Clicking it in this state interrupts the node's computation on the farm.

[ui] NodeActions: Add Retry button for submitted tasks on error state

45736d2

[GraphEditor] NodeChunks: Remove specific color for dynamic chunks

18e0b07

[ui] NodeActions: Fix status of compute and submit in deletable…

848c91e

… state

[GraphEditor] Add "Retry Error Tasks" menu to match NodeActions

7070652

[GraphEditor] Add "Interrupt/Cancel Job" menus

d80e5db

[GraphEditor] NodeChunks: Don't add specific display when there's no …

f328574

…chunk

[ui] Use chunk placeholder for uncreated dynamic chunks

1ba7776

[ui] Application: Update state of the global "Submit" icon when needed

fdee991

[core] node: Correctly use fullSize instead of nbChunks to set ch…

92b7794

…unks from cache

Correct typos

b8b6b42

[node] remove methods statusInThisSession & submitterStatusInThisSession

602962c

[graph] Fix a small issue in compareFilesTimes

def01dc

[core] node: Reset chunks before updating the node's size

c91dd6b

.git-blame-ignore-revs: Add linting commits

38211d6

cbentejac force-pushed the dev/delayChunkEvaluation branch from d1abeb6 to 38211d6 Compare January 2, 2026 10:28

cbentejac approved these changes Jan 2, 2026

View reviewed changes

cbentejac changed the title ~~[core] Delay chunk evaluation~~ [core] Add support for dynamic chunks Jan 2, 2026

cbentejac added majorFeature and removed feature new feature (proposed as PR or issue planned by dev) labels Jan 2, 2026

cbentejac merged commit f7a48c9 into develop Jan 2, 2026
2 of 4 checks passed

cbentejac deleted the dev/delayChunkEvaluation branch January 2, 2026 16:13

Uh oh!

[core] Add support for dynamic chunks #2918

[core] Add support for dynamic chunks #2918

Uh oh!

Conversation

Alxiice commented Oct 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Changes

Examples

Uh oh!

codecov bot commented Oct 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

cbentejac left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cbentejac left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Alxiice Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Alxiice Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Alxiice commented Oct 13, 2025 •

edited

Loading

codecov bot commented Oct 13, 2025 •

edited

Loading