alpha-avatar-host 0.6.8__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (56) hide show
  1. alpha_avatar_host-0.6.8/.gitignore +191 -0
  2. alpha_avatar_host-0.6.8/LICENSE +201 -0
  3. alpha_avatar_host-0.6.8/PKG-INFO +132 -0
  4. alpha_avatar_host-0.6.8/README.md +106 -0
  5. alpha_avatar_host-0.6.8/alphaavatar/host/__init__.py +16 -0
  6. alpha_avatar_host-0.6.8/alphaavatar/host/application/__init__.py +13 -0
  7. alpha_avatar_host-0.6.8/alphaavatar/host/application/application.py +241 -0
  8. alpha_avatar_host-0.6.8/alphaavatar/host/application/bootstrap.py +313 -0
  9. alpha_avatar_host-0.6.8/alphaavatar/host/application/config.py +39 -0
  10. alpha_avatar_host-0.6.8/alphaavatar/host/application/health.py +82 -0
  11. alpha_avatar_host-0.6.8/alphaavatar/host/application/signals.py +53 -0
  12. alpha_avatar_host-0.6.8/alphaavatar/host/cli/__init__.py +13 -0
  13. alpha_avatar_host-0.6.8/alphaavatar/host/cli/app.py +38 -0
  14. alpha_avatar_host-0.6.8/alphaavatar/host/cli/commands/__init__.py +13 -0
  15. alpha_avatar_host-0.6.8/alphaavatar/host/cli/commands/run.py +82 -0
  16. alpha_avatar_host-0.6.8/alphaavatar/host/configs/__init__.py +13 -0
  17. alpha_avatar_host-0.6.8/alphaavatar/host/configs/application.py +31 -0
  18. alpha_avatar_host-0.6.8/alphaavatar/host/configs/loader.py +114 -0
  19. alpha_avatar_host-0.6.8/alphaavatar/host/diagnostics.py +118 -0
  20. alpha_avatar_host-0.6.8/alphaavatar/host/execution/__init__.py +13 -0
  21. alpha_avatar_host-0.6.8/alphaavatar/host/execution/execution.py +79 -0
  22. alpha_avatar_host-0.6.8/alphaavatar/host/execution/manager.py +325 -0
  23. alpha_avatar_host-0.6.8/alphaavatar/host/execution/policy.py +31 -0
  24. alpha_avatar_host-0.6.8/alphaavatar/host/execution/schemas.py +43 -0
  25. alpha_avatar_host-0.6.8/alphaavatar/host/execution/stop.py +42 -0
  26. alpha_avatar_host-0.6.8/alphaavatar/host/log/__init__.py +18 -0
  27. alpha_avatar_host-0.6.8/alphaavatar/host/log/banner.py +60 -0
  28. alpha_avatar_host-0.6.8/alphaavatar/host/log/config.py +43 -0
  29. alpha_avatar_host-0.6.8/alphaavatar/host/log/format.py +68 -0
  30. alpha_avatar_host-0.6.8/alphaavatar/host/log/runtime.py +364 -0
  31. alpha_avatar_host-0.6.8/alphaavatar/host/log/timeline.py +390 -0
  32. alpha_avatar_host-0.6.8/alphaavatar/host/main.py +26 -0
  33. alpha_avatar_host-0.6.8/alphaavatar/host/processes/__init__.py +14 -0
  34. alpha_avatar_host-0.6.8/alphaavatar/host/processes/channel.py +36 -0
  35. alpha_avatar_host-0.6.8/alphaavatar/host/processes/config.py +27 -0
  36. alpha_avatar_host-0.6.8/alphaavatar/host/processes/entrypoint.py +196 -0
  37. alpha_avatar_host-0.6.8/alphaavatar/host/processes/group.py +55 -0
  38. alpha_avatar_host-0.6.8/alphaavatar/host/processes/process.py +461 -0
  39. alpha_avatar_host-0.6.8/alphaavatar/host/processes/schemas.py +60 -0
  40. alpha_avatar_host-0.6.8/alphaavatar/host/processes/supervisor.py +84 -0
  41. alpha_avatar_host-0.6.8/alphaavatar/host/sessions/__init__.py +13 -0
  42. alpha_avatar_host-0.6.8/alphaavatar/host/sessions/attachment.py +109 -0
  43. alpha_avatar_host-0.6.8/alphaavatar/host/sessions/base.py +60 -0
  44. alpha_avatar_host-0.6.8/alphaavatar/host/sessions/config.py +25 -0
  45. alpha_avatar_host-0.6.8/alphaavatar/host/sessions/factory.py +37 -0
  46. alpha_avatar_host-0.6.8/alphaavatar/host/sessions/livekit/__init__.py +14 -0
  47. alpha_avatar_host-0.6.8/alphaavatar/host/sessions/livekit/backend.py +308 -0
  48. alpha_avatar_host-0.6.8/alphaavatar/host/sessions/livekit/character.py +229 -0
  49. alpha_avatar_host-0.6.8/alphaavatar/host/sessions/livekit/config.py +79 -0
  50. alpha_avatar_host-0.6.8/alphaavatar/host/sessions/livekit/connection.py +203 -0
  51. alpha_avatar_host-0.6.8/alphaavatar/host/sessions/livekit/dispatch.py +459 -0
  52. alpha_avatar_host-0.6.8/alphaavatar/host/sessions/manager.py +93 -0
  53. alpha_avatar_host-0.6.8/alphaavatar/host/sessions/mode.py +59 -0
  54. alpha_avatar_host-0.6.8/alphaavatar/host/sessions/schemas.py +44 -0
  55. alpha_avatar_host-0.6.8/alphaavatar/host/version.py +14 -0
  56. alpha_avatar_host-0.6.8/pyproject.toml +50 -0
@@ -0,0 +1,191 @@
1
+ **/.vscode
2
+ **/.DS_Store
3
+
4
+ # Byte-compiled / optimized / DLL files
5
+ __pycache__/
6
+ *.py[cod]
7
+ *$py.class
8
+
9
+ # C extensions
10
+ *.so
11
+
12
+ # Distribution / packaging
13
+ .Python
14
+ build/
15
+ develop-eggs/
16
+ dist/
17
+ downloads/
18
+ eggs/
19
+ .eggs/
20
+ lib/
21
+ lib64/
22
+ parts/
23
+ sdist/
24
+ var/
25
+ wheels/
26
+ share/python-wheels/
27
+ *.egg-info/
28
+ .installed.cfg
29
+ *.egg
30
+ MANIFEST
31
+ KMS
32
+
33
+ # PyInstaller
34
+ # Usually these files are written by a python script from a template
35
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
36
+ *.manifest
37
+ *.spec
38
+
39
+ # Installer logs
40
+ pip-log.txt
41
+ pip-delete-this-directory.txt
42
+
43
+ # Unit test / coverage reports
44
+ htmlcov/
45
+ .tox/
46
+ .nox/
47
+ .coverage
48
+ .coverage.*
49
+ .cache
50
+ nosetests.xml
51
+ coverage.xml
52
+ *.cover
53
+ *.py,cover
54
+ .hypothesis/
55
+ .pytest_cache/
56
+ cover/
57
+
58
+ # Translations
59
+ *.mo
60
+ *.pot
61
+
62
+ # Django stuff:
63
+ *.log
64
+ local_settings.py
65
+ db.sqlite3
66
+ db.sqlite3-journal
67
+
68
+ # Flask stuff:
69
+ instance/
70
+ .webassets-cache
71
+
72
+ # Scrapy stuff:
73
+ .scrapy
74
+
75
+ # Sphinx documentation
76
+ docs/_build/
77
+
78
+ # PyBuilder
79
+ .pybuilder/
80
+ target/
81
+
82
+ # Jupyter Notebook
83
+ .ipynb_checkpoints
84
+
85
+ # IPython
86
+ profile_default/
87
+ ipython_config.py
88
+
89
+ # pyenv
90
+ # For a library or package, you might want to ignore these files since the code is
91
+ # intended to run in multiple environments; otherwise, check them in:
92
+ # .python-version
93
+
94
+ # pipenv
95
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
96
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
97
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
98
+ # install all needed dependencies.
99
+ #Pipfile.lock
100
+
101
+ # poetry
102
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
103
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
104
+ # commonly ignored for libraries.
105
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
106
+ #poetry.lock
107
+
108
+ # pdm
109
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
110
+ #pdm.lock
111
+ # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
112
+ # in version control.
113
+ # https://pdm.fming.dev/#use-with-ide
114
+ .pdm.toml
115
+
116
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
117
+ __pypackages__/
118
+
119
+ # Celery stuff
120
+ celerybeat-schedule
121
+ celerybeat.pid
122
+
123
+ # SageMath parsed files
124
+ *.sage.py
125
+
126
+ # Environments
127
+ .env
128
+ .env.dev
129
+ .env.demo
130
+ .env.personal
131
+ .env.prod
132
+ .venv
133
+ .venv*/
134
+ venv/
135
+ ENV/
136
+ env.bak/
137
+ venv.bak/
138
+
139
+ # Spyder project settings
140
+ .spyderproject
141
+ .spyproject
142
+
143
+ # Rope project settings
144
+ .ropeproject
145
+
146
+ # mkdocs documentation
147
+ /site
148
+
149
+ # mypy
150
+ .mypy_cache/
151
+ .dmypy.json
152
+ dmypy.json
153
+
154
+ # trunk
155
+ .trunk/
156
+
157
+ # Pyre type checker
158
+ .pyre/
159
+
160
+ # pytype static type analyzer
161
+ .pytype/
162
+
163
+ # Cython debug symbols
164
+ cython_debug/
165
+
166
+ # PyCharm
167
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
168
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
169
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
170
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
171
+ .idea/
172
+
173
+ auth
174
+ node_modules
175
+
176
+ credentials.json
177
+ pyrightconfig.json
178
+
179
+ # Database files
180
+ *.db
181
+ .alphaavatar_workspace
182
+
183
+ docs/releases/.generated/
184
+
185
+ # Local-only: dev-time verification and working notes, not part of the
186
+ # published tree.
187
+ /tests/
188
+ docs/_local/
189
+
190
+ # Local agent state, not part of the published tree.
191
+ .claude/
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,132 @@
1
+ Metadata-Version: 2.5
2
+ Name: alpha-avatar-host
3
+ Version: 0.6.8
4
+ Summary: Application assembly and execution hosting for AlphaAvatar.
5
+ Project-URL: Source, https://github.com/AlphaAvatar/AlphaAvatar
6
+ Project-URL: Issues, https://github.com/AlphaAvatar/AlphaAvatar/issues
7
+ License-Expression: Apache-2.0
8
+ License-File: LICENSE
9
+ Classifier: Intended Audience :: Developers
10
+ Classifier: Programming Language :: Python :: 3
11
+ Classifier: Programming Language :: Python :: 3 :: Only
12
+ Classifier: Programming Language :: Python :: 3.13
13
+ Requires-Python: <3.14,>=3.13
14
+ Requires-Dist: aiohttp<4,>=3.10
15
+ Requires-Dist: alpha-avatar-agents
16
+ Requires-Dist: alpha-avatar-core
17
+ Requires-Dist: omegaconf<3,>=2.3
18
+ Requires-Dist: pydantic<3,>=2
19
+ Requires-Dist: pyyaml<7,>=6
20
+ Provides-Extra: livekit
21
+ Requires-Dist: alpha-avatar-rtc[livekit]; extra == 'livekit'
22
+ Requires-Dist: livekit-api<2,>=1.0.4; extra == 'livekit'
23
+ Requires-Dist: livekit-protocol~=1.0; extra == 'livekit'
24
+ Requires-Dist: livekit<2,>=1.0.12; extra == 'livekit'
25
+ Description-Content-Type: text/markdown
26
+
27
+ # AlphaAvatar Host
28
+
29
+ `alpha-avatar-host` starts AlphaAvatar, owns shared inference, and supervises Avatar
30
+ executions. Interaction connections belong to session backends; Agents, Core and RTC
31
+ do not depend on Host. The App is not required to run the service.
32
+
33
+ ## ๐Ÿ“ฆ Package structure
34
+
35
+ ```text
36
+ alphaavatar/host/
37
+ โ”œโ”€โ”€ main.py # Public alphaavatar command.
38
+ โ”œโ”€โ”€ version.py
39
+ โ”œโ”€โ”€ cli/ # dev/start, arguments, help and version.
40
+ โ”œโ”€โ”€ configs/ # Strict Host/Avatar configuration loading.
41
+ โ”œโ”€โ”€ application/ # Bootstrap, shared services, health and signals.
42
+ โ”œโ”€โ”€ execution/ # Hosted execution ownership and end policies.
43
+ โ”œโ”€โ”€ processes/ # Execution subprocesses, IPC and bounded cleanup.
44
+ โ”œโ”€โ”€ sessions/ # Attachments, modes and backend selection.
45
+ โ”‚ โ””โ”€โ”€ livekit/ # Native dispatch, connections and Character transport.
46
+ โ””โ”€โ”€ log/ # Console, JSONL, previews and optional event diagnostics.
47
+ ```
48
+
49
+ [Startup overview](../.github/assets/avatar-host/start-up-flow.png) ยท
50
+ [Package overview](../.github/assets/avatar-host/relationships.png)
51
+
52
+ The diagrams are conceptual. Host holds execution handles in the parent process;
53
+ Engine, Runtime and their session adapters are assembled inside execution children.
54
+
55
+ ## Run
56
+
57
+ Use the repository's Python 3.13 environment and your configured provider credentials:
58
+
59
+ ```bash
60
+ alphaavatar --help
61
+ alphaavatar --version
62
+ ENV_FILE=.env.dev alphaavatar dev examples/agent_configs/mm/pipeline_openai_tools.yaml
63
+ alphaavatar start examples/agent_configs/mm/pipeline_openai_tools.yaml
64
+ ```
65
+
66
+ `dev` defaults to DEBUG and an available health port; it does not watch or reload code.
67
+ `start` defaults to INFO and port 8081. Help/version do not start models or require RTC
68
+ credentials. Configuration overrides use `key=value` after the filename.
69
+
70
+ ## Configuration
71
+
72
+ Keep the existing Avatar settings at the top level and add Host settings beside them:
73
+
74
+ ```yaml
75
+ host:
76
+ rtc:
77
+ backend: livekit
78
+ init_config:
79
+ connection_mode: dispatch
80
+ log:
81
+ events: false
82
+ conversation:
83
+ content: dev
84
+ file_content: false
85
+ ```
86
+
87
+ LiveKit requires `LIVEKIT_URL`, `LIVEKIT_API_KEY` and `LIVEKIT_API_SECRET`. Model and
88
+ tool providers need their own credentials. Remote endpoints require TLS.
89
+
90
+ | Connection mode | Behavior |
91
+ | --- | --- |
92
+ | `dispatch` | Registers using `avatar.name` and waits for matching explicit dispatches. The assignment supplies the room. Host remains available after a session ends. |
93
+ | `direct` | Requires `room_name`, optionally selects `participant_identity`, and exits after its single execution ends. It still requires LiveKit. |
94
+
95
+ The remote participant's `session_type` metadata selects `chat`, `agent`, `audio` or
96
+ `video`; the default is `video`. This is independent of connection mode and `dev/start`.
97
+
98
+ Logs show time, severity, source location, PID and content. `dev` previews committed user
99
+ input and recorded assistant text; `content: off` hides those previews and `content: all`
100
+ enables them in both commands. JSONL files are saved under the resolved Avatar workspace's
101
+ `.logs/host/`; conversation text is excluded unless `file_content: true`. Console capture
102
+ and provider traces have separate retention. Review all logs for personal data before sharing.
103
+
104
+ `host.log.events=true` with DEBUG enables sampled Core event metadata and gap diagnostics.
105
+ These logs preserve source stream identities and sequence numbers; they are not lossless
106
+ records or a globally ordered replay log. Do not log raw media or credentials.
107
+
108
+ ## Runtime boundaries
109
+
110
+ Host starts outputs before Engine and inputs. Detaching a session releases its adapters;
111
+ Host policy decides when its execution ends. Shared inference closes only after execution
112
+ children settle, and InferenceRuntime remains the sole owner of its runner processes.
113
+ Ctrl+C/SIGTERM request orderly shutdown; repeated Ctrl+C does not abandon cleanup.
114
+
115
+ Audio sessions use playback-driven captions through `TranscriptSynchronizationProcessor`.
116
+ PCM streams at the provider's native pace; caption publication and network sending do not
117
+ pace audio capture. PCM-only providers use estimated word timing, corrected by measured
118
+ audio duration. LiveKit playback feedback measures the local audio queue, not remote speakers.
119
+
120
+ The health endpoints are `/live`, `/ready` and `/status`; restrict their network exposure.
121
+ Execution supervision requires POSIX. Process groups are not complete descendant sandboxes;
122
+ deployments that need containment of detached browsers require an external cgroup/container.
123
+ One attachment per execution is supported. Reattachment, persistent execution recovery and
124
+ sleep/wake are not implemented. Control loss finishes affected jobs before re-registration;
125
+ it does not replay model or tool work. Disconnecting does not delete the room.
126
+
127
+ ## More information
128
+
129
+ [Deployment](../DEPLOY.md) ยท [Development](../CONTRIBUTING.md) ยท
130
+ [Avatar workspace](../docs/avatar-workspace-layout.md) ยท
131
+ [Model cache](../docs/models-cache-layout.md) ยท
132
+ [Character setup](../avatar-plugins/perception/avatar-plugins-character/README.md)
@@ -0,0 +1,106 @@
1
+ # AlphaAvatar Host
2
+
3
+ `alpha-avatar-host` starts AlphaAvatar, owns shared inference, and supervises Avatar
4
+ executions. Interaction connections belong to session backends; Agents, Core and RTC
5
+ do not depend on Host. The App is not required to run the service.
6
+
7
+ ## ๐Ÿ“ฆ Package structure
8
+
9
+ ```text
10
+ alphaavatar/host/
11
+ โ”œโ”€โ”€ main.py # Public alphaavatar command.
12
+ โ”œโ”€โ”€ version.py
13
+ โ”œโ”€โ”€ cli/ # dev/start, arguments, help and version.
14
+ โ”œโ”€โ”€ configs/ # Strict Host/Avatar configuration loading.
15
+ โ”œโ”€โ”€ application/ # Bootstrap, shared services, health and signals.
16
+ โ”œโ”€โ”€ execution/ # Hosted execution ownership and end policies.
17
+ โ”œโ”€โ”€ processes/ # Execution subprocesses, IPC and bounded cleanup.
18
+ โ”œโ”€โ”€ sessions/ # Attachments, modes and backend selection.
19
+ โ”‚ โ””โ”€โ”€ livekit/ # Native dispatch, connections and Character transport.
20
+ โ””โ”€โ”€ log/ # Console, JSONL, previews and optional event diagnostics.
21
+ ```
22
+
23
+ [Startup overview](../.github/assets/avatar-host/start-up-flow.png) ยท
24
+ [Package overview](../.github/assets/avatar-host/relationships.png)
25
+
26
+ The diagrams are conceptual. Host holds execution handles in the parent process;
27
+ Engine, Runtime and their session adapters are assembled inside execution children.
28
+
29
+ ## Run
30
+
31
+ Use the repository's Python 3.13 environment and your configured provider credentials:
32
+
33
+ ```bash
34
+ alphaavatar --help
35
+ alphaavatar --version
36
+ ENV_FILE=.env.dev alphaavatar dev examples/agent_configs/mm/pipeline_openai_tools.yaml
37
+ alphaavatar start examples/agent_configs/mm/pipeline_openai_tools.yaml
38
+ ```
39
+
40
+ `dev` defaults to DEBUG and an available health port; it does not watch or reload code.
41
+ `start` defaults to INFO and port 8081. Help/version do not start models or require RTC
42
+ credentials. Configuration overrides use `key=value` after the filename.
43
+
44
+ ## Configuration
45
+
46
+ Keep the existing Avatar settings at the top level and add Host settings beside them:
47
+
48
+ ```yaml
49
+ host:
50
+ rtc:
51
+ backend: livekit
52
+ init_config:
53
+ connection_mode: dispatch
54
+ log:
55
+ events: false
56
+ conversation:
57
+ content: dev
58
+ file_content: false
59
+ ```
60
+
61
+ LiveKit requires `LIVEKIT_URL`, `LIVEKIT_API_KEY` and `LIVEKIT_API_SECRET`. Model and
62
+ tool providers need their own credentials. Remote endpoints require TLS.
63
+
64
+ | Connection mode | Behavior |
65
+ | --- | --- |
66
+ | `dispatch` | Registers using `avatar.name` and waits for matching explicit dispatches. The assignment supplies the room. Host remains available after a session ends. |
67
+ | `direct` | Requires `room_name`, optionally selects `participant_identity`, and exits after its single execution ends. It still requires LiveKit. |
68
+
69
+ The remote participant's `session_type` metadata selects `chat`, `agent`, `audio` or
70
+ `video`; the default is `video`. This is independent of connection mode and `dev/start`.
71
+
72
+ Logs show time, severity, source location, PID and content. `dev` previews committed user
73
+ input and recorded assistant text; `content: off` hides those previews and `content: all`
74
+ enables them in both commands. JSONL files are saved under the resolved Avatar workspace's
75
+ `.logs/host/`; conversation text is excluded unless `file_content: true`. Console capture
76
+ and provider traces have separate retention. Review all logs for personal data before sharing.
77
+
78
+ `host.log.events=true` with DEBUG enables sampled Core event metadata and gap diagnostics.
79
+ These logs preserve source stream identities and sequence numbers; they are not lossless
80
+ records or a globally ordered replay log. Do not log raw media or credentials.
81
+
82
+ ## Runtime boundaries
83
+
84
+ Host starts outputs before Engine and inputs. Detaching a session releases its adapters;
85
+ Host policy decides when its execution ends. Shared inference closes only after execution
86
+ children settle, and InferenceRuntime remains the sole owner of its runner processes.
87
+ Ctrl+C/SIGTERM request orderly shutdown; repeated Ctrl+C does not abandon cleanup.
88
+
89
+ Audio sessions use playback-driven captions through `TranscriptSynchronizationProcessor`.
90
+ PCM streams at the provider's native pace; caption publication and network sending do not
91
+ pace audio capture. PCM-only providers use estimated word timing, corrected by measured
92
+ audio duration. LiveKit playback feedback measures the local audio queue, not remote speakers.
93
+
94
+ The health endpoints are `/live`, `/ready` and `/status`; restrict their network exposure.
95
+ Execution supervision requires POSIX. Process groups are not complete descendant sandboxes;
96
+ deployments that need containment of detached browsers require an external cgroup/container.
97
+ One attachment per execution is supported. Reattachment, persistent execution recovery and
98
+ sleep/wake are not implemented. Control loss finishes affected jobs before re-registration;
99
+ it does not replay model or tool work. Disconnecting does not delete the room.
100
+
101
+ ## More information
102
+
103
+ [Deployment](../DEPLOY.md) ยท [Development](../CONTRIBUTING.md) ยท
104
+ [Avatar workspace](../docs/avatar-workspace-layout.md) ยท
105
+ [Model cache](../docs/models-cache-layout.md) ยท
106
+ [Character setup](../avatar-plugins/perception/avatar-plugins-character/README.md)
@@ -0,0 +1,16 @@
1
+ # Copyright 2026 AlphaAvatar project
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+ from .version import __version__
15
+
16
+ __all__ = ["__version__"]
@@ -0,0 +1,13 @@
1
+ # Copyright 2026 AlphaAvatar project
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.