Skip to content

Commit

Permalink
warn users use_sequence=no is not supported
Browse files Browse the repository at this point in the history
  • Loading branch information
pliablepixels committed May 16, 2021
1 parent 02097e3 commit 2c274dc
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/guides/hooks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -343,6 +343,13 @@ per type of detection.
More details: What happens when you go with use_sequence=no?
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

**NOTE**: Please use ``use_sequence=yes``. In the past, I've allowed a mode where legacy settings were converted
to ``stream_sequence`` auto-magically when I changed formats. This caused a lot of issues and was a
nightmare to maintain. So please migrate to the proper format. If you've been using ``use_sequence=no``
it will likely break things, but please read the help and convert properly. ``use_sequence=no`` is no
longer maintained.


In the old way, the following 'global' variables (which could be overriden on a per monitor basis) defined how
ML would work:

Expand Down Expand Up @@ -537,6 +544,12 @@ If you are using the remote mlapi server, then most of these settings migrate to
Specifically, when ``zm_detect.py`` sees ``ml_gateway`` in its ``[remote]`` section, it passes on
the detection work to mlapi.

**NOTE**: Please use ``use_sequence=yes``. In the past, I've allowed a mode where legacy settings were converted
to ``stream_sequence`` auto-magically when I changed formats. This caused a lot of issues and was a
nightmare to maintain. So please migrate to the proper format. If you've been using ``use_sequence=no``
it will likely break things, but please read the help and convert properly. ``use_sequence=no`` is no
longer maintained.

Here are a list of parameters that still need to be in ``objectconfig.ini`` when using mlapi.
(A simple rule to remember is zm_detect.py uses ``objectconfig.ini`` while mlapi uses ``mlapiconfig.ini``)

Expand Down

0 comments on commit 2c274dc

Please sign in to comment.