Fix/restructure

[klemen1999]

Purpose

Restructures project structure so that the classes are accessable in similar pattern as with DepthAI.

Specification

Moved all messages and message creators under message. Nodes are now under node (for now only parsers are in their own folder).

Dependencies & Potential Impact

Previously:

from depthai_nodes import ParsingNeuralNetwork
from depthai_nodes import Classifications
from depthai_nodes import ClassificationParser

Now:

from depthai_nodes.node import ParsingNeuralNetwork
from depthai_nodes import Classifications
from depthai_nodes.node import ClassificationParser

Deployment Plan

This is a breaking change so when merged in all scripts (e.g. depthai-experiments) relying on unreleased, main branch of dai-nodes will faill because of import errors. So before merge we should have PRs on other relevant projects that depend on this one already made.

Testing & Validation

Tests were adjusted for the new structure.

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 91.87817% with 16 lines in your changes missing coverage. Please review.

Project coverage is 38.63%. Comparing base (78903fc) to head (3ab33d4).

✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
depthai_nodes/node/parsers/utils/keypoints.py	13.33%	13 Missing ⚠️
depthai_nodes/node/parser_generator.py	83.33%	1 Missing ⚠️
depthai_nodes/node/parsers/utils/activations.py	75.00%	1 Missing ⚠️
depthai_nodes/node/tiles_patcher.py	66.66%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #173      +/-   ##
==========================================
+ Coverage   38.42%   38.63%   +0.21%     
==========================================
  Files          78       75       -3     
  Lines        4305     4253      -52     
==========================================
- Hits         1654     1643      -11     
+ Misses       2651     2610      -41     

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

[PetrNovota]

Good job on re-structuring the depthai_nodes package. The agreed upon user facing structure is there.

I try to avoid utils packages as much as possible, I think the top-level one, where the constants.py and logging.py are, should be removed. I would move the scripts to the top level.

The node.parsers.utils is a collection of many different things and again applies that the utils package is not a good solution, it doesn't say much about its contains. It's a collections of things we did not know where to put them. But we probably don't have the resources to do something about this atm.

What is the motivation behind creating the creators package in the messages? To me, it just looks like what should be part of the class constructors has been moved to separate functions for some reason. I don't see why this is needed. Things that belong together should be together. Object construction usually happens in the constructor of a class, so why not use it?

[dominik737]

Looks good. As was suggested by Petr in the future it would be nice to get rid of the utils and alike folders in the repo. Also using the constructor instead of the functional creators would be nice in the future.

For now it's good that both these things that we would like to change in the future are quite internal to the library. Thus no big breaking changes affecting users will be introduced.

[jkbmrz]

Generally LGTM. However, I'm wondering what’s the reasoning behind having the node directory at the top level of depthai_nodes? It feels a bit odd. Would it make sense to move parsers to the top level and rename node to helpers instead? That way, the imports would be more intuitive:

• depthai_nodes.message
• depthai_nodes.parsers
• depthai_nodes.helpers

Additionally, I’d recommend using plural forms for module names (e.g., message → messages, node → nodes) since the modules contain multiple related classes or functions.

[klemen1999]

@jkbmrz
Main reason is that we want to "mimic" how depthai already does it so we have same pattern of accesing "same things". And how DAI does it is: Messages are importable top level like depthai.ImgDetections() and all nodes are importable like depthai.node.NeuralNetwork().
And same reasoning goes for plural vs singular - DAI has singular so we want to be inline with them.

[kkeroo]

LGTM. One note: inside node folder we have parsers folder where parsers are but other "host nodes" like DepthMerger are left in the node folder. In the future we should probably move them to separate subfolder when there will be a lot of such nodes?

[dominik737]

@kkeroo
Yes, the idea is that now there are a few nodes and no meaningful groups can be formed yet. When we have more nodes we should be able to group them into subfolders.