Add Render Animation Worker Job #7348

fm3 · 2023-09-19T12:10:37Z

This PR adds the frontend and backend feature for starting a animation job of the current annotation / dataset.

URL of deployed dev instance (used for testing):

https://___.webknossos.xyz

Steps to test:

Start a worker with animation job (Export 3D render via worker job #7338)
Test in View mode and for an annotation
For "Menu" in navbar select "Create Animation"
Play around with available options to create various animations
Restrict your orga to "Basic" plan and check plan enforcement

Issues:

fixes Export 3D render via worker job #7338

Updated changelog
Removed dev-only changes like prints and application.conf edits
Considered common edge cases

…der-animation

…s into render-animation

hotzenklotz · 2023-10-17T08:09:37Z

frontend/javascripts/oxalis/view/action-bar/tracing_actions_view.tsx

@@ -684,6 +690,18 @@ class TracingActionsView extends React.PureComponent<Props, State> {
    }

    menuItems.push(screenshotMenuItem);
+
+    if (activeUser?.isSuperUser) {


This is by design. Let's do a soft launch and try some larger datasets on the server first before releasing this publicly.

hotzenklotz · 2023-10-17T08:12:39Z

@philippotto I think this is ready for review. Feel free to only review the WK side. In case you setup up the worker too, perhaps you can do a rough review for that as well. Thanks.

I will create a page for the WK documentation later this week in a separate PR. Let's try to get this merged and soft launched for super users so that we can iron out any issue with the worker deployment and test performance in the real world.

fm3 · 2023-10-17T09:03:55Z

I’d say the backend changes are straightforward enough that they don’t require a specialized review. @philippotto maybe you could quickly read through them as well while checking the front-end

philippotto

awesome stuff 👍 only left a couple of nitpicks.

also, one thing UX wise: I'd put the word "video" somewhere to clarify that the output medium is a video file. otherwise, it might be unclear to the user what they will get (a gif? a blender file? an upload to youtube?).

frontend/javascripts/oxalis/view/action-bar/create_animation_modal.tsx

philippotto · 2023-10-17T14:12:22Z

frontend/javascripts/oxalis/view/action-bar/create_animation_modal.tsx

+    let meshFileName = "meshfile.hdf5";
+    let segmentationLayerName = "segmentatation";


what's up with these? why not initialize these with null and then show an error in case no mesh files were found later?
also, there's a typo in segmentation.

Mhm, the backend expects a string - hence the defaults. If any mesh is rendered is mostly controlled by the submitted segment IDs.

Showing an error is a good idea.

If this is optional then I’d say the backend should also understand that. I can probably add that today.

I rechecked the backend and worker code, and there the type is segmentationLayerName: Option[String] and meshFileName: Option[String], so it should be possible to make this optional in the frontend already.

I switched the frontend values to undefined by default.

frontend/javascripts/oxalis/view/action-bar/create_animation_modal.tsx

philippotto · 2023-10-18T08:42:20Z

I’d say the backend changes are straightforward enough that they don’t require a specialized review. @philippotto maybe you could quickly read through them as well while checking the front-end

I did that yesterday, too, and everything looked good to me :)

…odal.tsx Co-authored-by: Philipp Otto <philippotto@users.noreply.github.com>

…der-animation

hotzenklotz · 2023-10-18T15:17:34Z

@fm3 Did you built email notifications for this job as well?

fm3 · 2023-10-19T07:46:47Z

I did not adapt the email code, no. My understanding is that a generic job completed email will be sent? Feel free to add a specialized email though :) Or I could do it as well if you tell me what it should say

hotzenklotz · 2023-10-19T07:48:22Z

I did not adapt the email code, no. My understanding is that a generic job completed email will be sent? Feel free to add a specialized email though :) Or I could do it as well if you tell me what it should say

I haven't tried the email notifications on my local dev setup (not configured). Let's start a soft launch and figure this out as well.

fm3 · 2023-10-19T09:21:01Z

I haven't tried the email notifications on my local dev setup (not configured). Let's start a soft launch and figure this out as well.

Sounds fair :) Then I guess the only remaining blockers are the frontend code review comments by philipp

philippotto

Good stuff 👍

hotzenklotz · 2023-10-24T08:09:11Z

Follow Up Issue: #3350

fm3 added 4 commits September 11, 2023 17:46

WIP: Add Render Animation Worker Job

2924148

cleanup

24432c5

lint

d74ad1f

format frontend

ba701ed

fm3 added backend frontend worker labels Sep 19, 2023

fm3 self-assigned this Sep 19, 2023

fm3 marked this pull request as draft September 19, 2023 12:10

hotzenklotz added 5 commits September 27, 2023 14:09

Merge branch 'master' of github.com:scalableminds/webknossos into ren…

e5cf8bf

…der-animation

added modal for blender animation

2821c58

more tuning for animation modal

2f596ca

added animation job options to frontend + backend

b751514

further tweaks to animation modal

f9e103a

hotzenklotz mentioned this pull request Sep 28, 2023

Export 3D render via worker job #7338

Closed

7 tasks

fm3 and others added 15 commits September 28, 2023 14:02

assert SD resolution and watermark if organization pricing plan is basic

0dffa6f

iterate on render animation job

8a3dd07

format

cd9c385

Merge branch 'master' into render-animation

2fe1399

send parameters not as json to worker

7c2060e

adapt modal to mockup

a32c3fb

pretty

0bccc47

Merge branch 'master' into render-animation

f7103a9

cleanup modal, make typechecker happy

644638f

rename options to animation_options

3a3e85f

Merge branch 'render-animation' of github.com:scalableminds/webknosso…

d4a5dc6

…s into render-animation

rename animation modal to CreateAnimationModal

1083808

added selected meshes to animation job

44737e4

added color layer intensities to animation

7dc1deb

added frontend validaton to create animation job

e36805e

hotzenklotz changed the title ~~WIP: Add Render Animation Worker Job~~ Add Render Animation Worker Job Oct 17, 2023

hotzenklotz reviewed Oct 17, 2023

View reviewed changes

hotzenklotz requested review from philippotto and hotzenklotz and removed request for hotzenklotz October 17, 2023 08:12

hotzenklotz and others added 2 commits October 17, 2023 10:18

format

260d054

undo dev-only changes in application.conf

1e63fe4

philippotto requested changes Oct 17, 2023

View reviewed changes

hotzenklotz and others added 5 commits October 18, 2023 13:42

Update frontend/javascripts/oxalis/view/action-bar/create_animation_m…

e4b7b8b

…odal.tsx Co-authored-by: Philipp Otto <philippotto@users.noreply.github.com>

Update frontend/javascripts/oxalis/view/action-bar/create_animation_m…

f121c02

…odal.tsx Co-authored-by: Philipp Otto <philippotto@users.noreply.github.com>

PR feedback

87089c2

Merge branch 'master' of github.com:scalableminds/webknossos into ren…

d5ec95e

…der-animation

PR feedback #2

ff28240

set default values to undefined

74cebf0

hotzenklotz requested a review from philippotto October 20, 2023 13:37

philippotto approved these changes Oct 20, 2023

View reviewed changes

hotzenklotz merged commit 6ba55b6 into master Oct 23, 2023
2 checks passed

hotzenklotz deleted the render-animation branch October 23, 2023 08:05

hotzenklotz mentioned this pull request Oct 23, 2023

Added email notifications for Blender animation job #7401

Merged

7 tasks

philippotto mentioned this pull request Nov 20, 2023

Use GPU in Render Animation Worker Job #7445

Open

2 tasks

hotzenklotz mentioned this pull request Nov 22, 2023

Enable video animations for all users #7452

Merged

7 tasks

hotzenklotz mentioned this pull request Mar 18, 2024

Use new mesh API for animation job #7692

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Render Animation Worker Job #7348

Add Render Animation Worker Job #7348

fm3 commented Sep 19, 2023 •

edited

hotzenklotz Oct 17, 2023

hotzenklotz commented Oct 17, 2023

fm3 commented Oct 17, 2023

philippotto left a comment

philippotto Oct 17, 2023

hotzenklotz Oct 18, 2023

fm3 Oct 19, 2023

fm3 Oct 19, 2023 •

edited

hotzenklotz Oct 20, 2023

philippotto commented Oct 18, 2023

hotzenklotz commented Oct 18, 2023

fm3 commented Oct 19, 2023

hotzenklotz commented Oct 19, 2023

fm3 commented Oct 19, 2023

philippotto left a comment

hotzenklotz commented Oct 24, 2023

		let meshFileName = "meshfile.hdf5";
		let segmentationLayerName = "segmentatation";

Add Render Animation Worker Job #7348

Add Render Animation Worker Job #7348

Conversation

fm3 commented Sep 19, 2023 • edited

URL of deployed dev instance (used for testing):

Steps to test:

Issues:

hotzenklotz Oct 17, 2023

Choose a reason for hiding this comment

hotzenklotz commented Oct 17, 2023

fm3 commented Oct 17, 2023

philippotto left a comment

Choose a reason for hiding this comment

philippotto Oct 17, 2023

Choose a reason for hiding this comment

hotzenklotz Oct 18, 2023

Choose a reason for hiding this comment

fm3 Oct 19, 2023

Choose a reason for hiding this comment

fm3 Oct 19, 2023 • edited

Choose a reason for hiding this comment

hotzenklotz Oct 20, 2023

Choose a reason for hiding this comment

philippotto commented Oct 18, 2023

hotzenklotz commented Oct 18, 2023

fm3 commented Oct 19, 2023

hotzenklotz commented Oct 19, 2023

fm3 commented Oct 19, 2023

philippotto left a comment

Choose a reason for hiding this comment

hotzenklotz commented Oct 24, 2023

fm3 commented Sep 19, 2023 •

edited

fm3 Oct 19, 2023 •

edited