Skip to content

Commit b9dd2e9

Browse files
pliablepixelsclaude
andcommitted
docs: point at pyzmng.readthedocs.io and connect the remote sections
The RTD project was renamed to pyzmNg in df09f17 but every URL still said pyzmv2 -- setup.py, the README and six examples. All now point at pyzmng.readthedocs.io. CHANGELOG is left alone: those entries are historical. The remote sections were also reachable only by scrolling. Wired them up: model discovery now points forward to the correlation rule and to the declaring-models section (which gained a label), /models and /infer point at the correlation rule from the API reference, and the ZoneMinder back-reference is a real list of links instead of a prose "see the other docs". Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
1 parent 33eec7d commit b9dd2e9

8 files changed

Lines changed: 35 additions & 19 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ It's a pythonic wrapper that integrates with ZM and also operates as a standalon
1313

1414
Installation
1515
=============
16-
See the [installation guide](https://pyzmv2.readthedocs.io/en/latest/guide/installation.html) on ReadTheDocs.
16+
See the [installation guide](https://pyzmng.readthedocs.io/en/latest/guide/installation.html) on ReadTheDocs.
1717

1818
Documentation & Examples
1919
=========================
20-
Latest documentation is available <a href='https://pyzmv2.readthedocs.io/en/latest/'>here</a>. The documentation includes a full example.
20+
Latest documentation is available <a href='https://pyzmng.readthedocs.io/en/latest/'>here</a>. The documentation includes a full example.
2121

2222
Features
2323
=========

docs/guide/serve.rst

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -261,6 +261,12 @@ any name you pass is looked up as follows:
261261
2. **File stem match** -- any ``<name>.onnx``, ``<name>.weights``, or
262262
``<name>.tflite`` in any subdirectory of ``base_path``
263263

264+
This lookup only works for models that *have* a weights file, and it always
265+
yields ``type: object`` -- see
266+
:ref:`serve-correlation` for what that means for a client, and
267+
:ref:`Declaring models <serve-declaring>` for the models that need an explicit
268+
declaration instead.
269+
264270
The framework is inferred from the file extension:
265271

266272
- ``.onnx`` -- OpenCV DNN (ONNX runtime)
@@ -346,6 +352,8 @@ even when the names match exactly.
346352
Confirm both halves of the pair with ``GET /models``, which reports the ``name``
347353
and ``type`` of everything loaded.
348354

355+
.. _serve-declaring:
356+
349357
Declaring models: two forms, and when each works
350358
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
351359

@@ -839,7 +847,8 @@ Health check. Returns:
839847
~~~~~~~~~~~~~~~~
840848

841849
Returns the list of available models and their load status. Useful with
842-
``--models all`` to check which backends have been lazily loaded.
850+
``--models all`` to check which backends have been lazily loaded, and to confirm
851+
the ``name`` and ``type`` a client must ask for (:ref:`serve-correlation`).
843852

844853
.. code-block:: json
845854
@@ -889,7 +898,8 @@ results.
889898
890899
When the server has no model for the requested ``(type, name)``,
891900
``detections`` is empty and ``error`` explains why (the client logs it and
892-
continues, like a local model that fails to load).
901+
continues, like a local model that fails to load). Both halves of that pair
902+
must match something loaded here -- see :ref:`serve-correlation`.
893903

894904
.. note::
895905

@@ -954,6 +964,12 @@ While first setting a gateway up, use ``ml_fallback_local: "no"`` so a gateway
954964
problem fails loudly instead of quietly running locally and looking like it
955965
worked.
956966

957-
The full ZoneMinder-side guide, including the ownership split and a
958-
troubleshooting table, is in the zmeventnotificationNg docs under
959-
*Using the remote ML detection server*.
967+
The full ZoneMinder-side guide is in the zmeventnotificationNg docs:
968+
969+
- `Using the remote ML detection server <https://zmeventnotificationng.readthedocs.io/en/latest/guides/hooks.html#remote-ml-config>`__
970+
-- end-to-end setup for both boxes
971+
- `Matching model names <https://zmeventnotificationng.readthedocs.io/en/latest/guides/hooks.html#remote-model-names>`__
972+
-- the same correlation rule as :ref:`serve-correlation`, from the client side
973+
- `Which side owns which setting <https://zmeventnotificationng.readthedocs.io/en/latest/guides/hooks.html#remote-config-ownership>`__
974+
- `Verifying a remote setup <https://zmeventnotificationng.readthedocs.io/en/latest/guides/hooks.html#verifying-a-remote-setup>`__
975+
-- commands that prove a run went remote, plus a symptom/cause table

examples/audio.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
1414
See also:
1515
Detection options, multi-model pipelines:
16-
https://pyzmv2.readthedocs.io/en/latest/guide/detection.html
16+
https://pyzmng.readthedocs.io/en/latest/guide/detection.html
1717
"""
1818

1919
import sys

examples/example_v2.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
Each section is self-contained. Comment/uncomment what you need.
55
66
See also:
7-
Full documentation: https://pyzmv2.readthedocs.io/en/latest/
8-
Quick-start guide: https://pyzmv2.readthedocs.io/en/latest/guide/quickstart.html
9-
Detection options: https://pyzmv2.readthedocs.io/en/latest/guide/detection.html
10-
Remote server: https://pyzmv2.readthedocs.io/en/latest/guide/serve.html
7+
Full documentation: https://pyzmng.readthedocs.io/en/latest/
8+
Quick-start guide: https://pyzmng.readthedocs.io/en/latest/guide/quickstart.html
9+
Detection options: https://pyzmng.readthedocs.io/en/latest/guide/detection.html
10+
Remote server: https://pyzmng.readthedocs.io/en/latest/guide/serve.html
1111
"""
1212

1313
import pyzm

examples/image.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
77
See also:
88
Multi-model configs, zones, from_dict():
9-
https://pyzmv2.readthedocs.io/en/latest/guide/detection.html
9+
https://pyzmng.readthedocs.io/en/latest/guide/detection.html
1010
Quick-start guide:
11-
https://pyzmv2.readthedocs.io/en/latest/guide/quickstart.html
11+
https://pyzmng.readthedocs.io/en/latest/guide/quickstart.html
1212
"""
1313

1414
import sys

examples/remote.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@
2626
2727
See also:
2828
Server setup, authentication, YAML config, API reference:
29-
https://pyzmv2.readthedocs.io/en/latest/guide/serve.html
29+
https://pyzmng.readthedocs.io/en/latest/guide/serve.html
3030
Quick-start guide:
31-
https://pyzmv2.readthedocs.io/en/latest/guide/quickstart.html
31+
https://pyzmng.readthedocs.io/en/latest/guide/quickstart.html
3232
"""
3333

3434
import sys

examples/stream.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
77
See also:
88
StreamConfig options, frame strategies, multi-model pipelines:
9-
https://pyzmv2.readthedocs.io/en/latest/guide/detection.html
9+
https://pyzmng.readthedocs.io/en/latest/guide/detection.html
1010
Quick-start guide:
11-
https://pyzmv2.readthedocs.io/en/latest/guide/quickstart.html
11+
https://pyzmng.readthedocs.io/en/latest/guide/quickstart.html
1212
"""
1313

1414
import sys

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ def find_version(*file_paths):
6060
author_email = AUTHOR_EMAIL,
6161
url = URL,
6262
project_urls={
63-
'Documentation': 'https://pyzmv2.readthedocs.io/en/latest/',
63+
'Documentation': 'https://pyzmng.readthedocs.io/en/latest/',
6464
'Source': 'https://github.com/ZoneMinder/pyzmNg',
6565
'Bug Tracker': 'https://github.com/ZoneMinder/pyzmNg/issues',
6666
},

0 commit comments

Comments
 (0)