dynaface 2.1.0__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 (34) hide show
  1. dynaface-2.1.0/LICENSE +203 -0
  2. dynaface-2.1.0/MANIFEST.in +5 -0
  3. dynaface-2.1.0/PKG-INFO +165 -0
  4. dynaface-2.1.0/README.md +115 -0
  5. dynaface-2.1.0/dynaface/__init__.py +13 -0
  6. dynaface-2.1.0/dynaface/__pyinstaller/__init__.py +10 -0
  7. dynaface-2.1.0/dynaface/__pyinstaller/hook-dynaface.py +12 -0
  8. dynaface-2.1.0/dynaface/cheek.py +969 -0
  9. dynaface-2.1.0/dynaface/cheek_outline.py +1261 -0
  10. dynaface-2.1.0/dynaface/config.py +16 -0
  11. dynaface-2.1.0/dynaface/const.py +38 -0
  12. dynaface-2.1.0/dynaface/dynaface_onnx.py +543 -0
  13. dynaface-2.1.0/dynaface/facial.py +1536 -0
  14. dynaface-2.1.0/dynaface/image.py +644 -0
  15. dynaface-2.1.0/dynaface/lateral.py +1152 -0
  16. dynaface-2.1.0/dynaface/measures.py +192 -0
  17. dynaface-2.1.0/dynaface/measures_base.py +286 -0
  18. dynaface-2.1.0/dynaface/measures_cheek.py +1036 -0
  19. dynaface-2.1.0/dynaface/measures_frontal.py +999 -0
  20. dynaface-2.1.0/dynaface/measures_lateral.py +192 -0
  21. dynaface-2.1.0/dynaface/measures_skin.py +186 -0
  22. dynaface-2.1.0/dynaface/models.py +186 -0
  23. dynaface-2.1.0/dynaface/resample.py +245 -0
  24. dynaface-2.1.0/dynaface/util.py +534 -0
  25. dynaface-2.1.0/dynaface/version.py +4 -0
  26. dynaface-2.1.0/dynaface/video.py +562 -0
  27. dynaface-2.1.0/dynaface.egg-info/PKG-INFO +165 -0
  28. dynaface-2.1.0/dynaface.egg-info/SOURCES.txt +33 -0
  29. dynaface-2.1.0/dynaface.egg-info/dependency_links.txt +1 -0
  30. dynaface-2.1.0/dynaface.egg-info/entry_points.txt +3 -0
  31. dynaface-2.1.0/dynaface.egg-info/requires.txt +25 -0
  32. dynaface-2.1.0/dynaface.egg-info/top_level.txt +1 -0
  33. dynaface-2.1.0/setup.cfg +87 -0
  34. dynaface-2.1.0/setup.py +3 -0
dynaface-2.1.0/LICENSE ADDED
@@ -0,0 +1,203 @@
1
+ Copyright 2025 Jeff Heaton
2
+
3
+ Apache License
4
+ Version 2.0, January 2004
5
+ http://www.apache.org/licenses/
6
+
7
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
8
+
9
+ 1. Definitions.
10
+
11
+ "License" shall mean the terms and conditions for use, reproduction,
12
+ and distribution as defined by Sections 1 through 9 of this document.
13
+
14
+ "Licensor" shall mean the copyright owner or entity authorized by
15
+ the copyright owner that is granting the License.
16
+
17
+ "Legal Entity" shall mean the union of the acting entity and all
18
+ other entities that control, are controlled by, or are under common
19
+ control with that entity. For the purposes of this definition,
20
+ "control" means (i) the power, direct or indirect, to cause the
21
+ direction or management of such entity, whether by contract or
22
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
23
+ outstanding shares, or (iii) beneficial ownership of such entity.
24
+
25
+ "You" (or "Your") shall mean an individual or Legal Entity
26
+ exercising permissions granted by this License.
27
+
28
+ "Source" form shall mean the preferred form for making modifications,
29
+ including but not limited to software source code, documentation
30
+ source, and configuration files.
31
+
32
+ "Object" form shall mean any form resulting from mechanical
33
+ transformation or translation of a Source form, including but
34
+ not limited to compiled object code, generated documentation,
35
+ and conversions to other media types.
36
+
37
+ "Work" shall mean the work of authorship, whether in Source or
38
+ Object form, made available under the License, as indicated by a
39
+ copyright notice that is included in or attached to the work
40
+ (an example is provided in the Appendix below).
41
+
42
+ "Derivative Works" shall mean any work, whether in Source or Object
43
+ form, that is based on (or derived from) the Work and for which the
44
+ editorial revisions, annotations, elaborations, or other modifications
45
+ represent, as a whole, an original work of authorship. For the purposes
46
+ of this License, Derivative Works shall not include works that remain
47
+ separable from, or merely link (or bind by name) to the interfaces of,
48
+ the Work and Derivative Works thereof.
49
+
50
+ "Contribution" shall mean any work of authorship, including
51
+ the original version of the Work and any modifications or additions
52
+ to that Work or Derivative Works thereof, that is intentionally
53
+ submitted to Licensor for inclusion in the Work by the copyright owner
54
+ or by an individual or Legal Entity authorized to submit on behalf of
55
+ the copyright owner. For the purposes of this definition, "submitted"
56
+ means any form of electronic, verbal, or written communication sent
57
+ to the Licensor or its representatives, including but not limited to
58
+ communication on electronic mailing lists, source code control systems,
59
+ and issue tracking systems that are managed by, or on behalf of, the
60
+ Licensor for the purpose of discussing and improving the Work, but
61
+ excluding communication that is conspicuously marked or otherwise
62
+ designated in writing by the copyright owner as "Not a Contribution."
63
+
64
+ "Contributor" shall mean Licensor and any individual or Legal Entity
65
+ on behalf of whom a Contribution has been received by Licensor and
66
+ subsequently incorporated within the Work.
67
+
68
+ 2. Grant of Copyright License. Subject to the terms and conditions of
69
+ this License, each Contributor hereby grants to You a perpetual,
70
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
71
+ copyright license to reproduce, prepare Derivative Works of,
72
+ publicly display, publicly perform, sublicense, and distribute the
73
+ Work and such Derivative Works in Source or Object form.
74
+
75
+ 3. Grant of Patent License. Subject to the terms and conditions of
76
+ this License, each Contributor hereby grants to You a perpetual,
77
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
78
+ (except as stated in this section) patent license to make, have made,
79
+ use, offer to sell, sell, import, and otherwise transfer the Work,
80
+ where such license applies only to those patent claims licensable
81
+ by such Contributor that are necessarily infringed by their
82
+ Contribution(s) alone or by combination of their Contribution(s)
83
+ with the Work to which such Contribution(s) was submitted. If You
84
+ institute patent litigation against any entity (including a
85
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
86
+ or a Contribution incorporated within the Work constitutes direct
87
+ or contributory patent infringement, then any patent licenses
88
+ granted to You under this License for that Work shall terminate
89
+ as of the date such litigation is filed.
90
+
91
+ 4. Redistribution. You may reproduce and distribute copies of the
92
+ Work or Derivative Works thereof in any medium, with or without
93
+ modifications, and in Source or Object form, provided that You
94
+ meet the following conditions:
95
+
96
+ (a) You must give any other recipients of the Work or
97
+ Derivative Works a copy of this License; and
98
+
99
+ (b) You must cause any modified files to carry prominent notices
100
+ stating that You changed the files; and
101
+
102
+ (c) You must retain, in the Source form of any Derivative Works
103
+ that You distribute, all copyright, patent, trademark, and
104
+ attribution notices from the Source form of the Work,
105
+ excluding those notices that do not pertain to any part of
106
+ the Derivative Works; and
107
+
108
+ (d) If the Work includes a "NOTICE" text file as part of its
109
+ distribution, then any Derivative Works that You distribute must
110
+ include a readable copy of the attribution notices contained
111
+ within such NOTICE file, excluding those notices that do not
112
+ pertain to any part of the Derivative Works, in at least one
113
+ of the following places: within a NOTICE text file distributed
114
+ as part of the Derivative Works; within the Source form or
115
+ documentation, if provided along with the Derivative Works; or,
116
+ within a display generated by the Derivative Works, if and
117
+ wherever such third-party notices normally appear. The contents
118
+ of the NOTICE file are for informational purposes only and
119
+ do not modify the License. You may add Your own attribution
120
+ notices within Derivative Works that You distribute, alongside
121
+ or as an addendum to the NOTICE text from the Work, provided
122
+ that such additional attribution notices cannot be construed
123
+ as modifying the License.
124
+
125
+ You may add Your own copyright statement to Your modifications and
126
+ may provide additional or different license terms and conditions
127
+ for use, reproduction, or distribution of Your modifications, or
128
+ for any such Derivative Works as a whole, provided Your use,
129
+ reproduction, and distribution of the Work otherwise complies with
130
+ the conditions stated in this License.
131
+
132
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
133
+ any Contribution intentionally submitted for inclusion in the Work
134
+ by You to the Licensor shall be under the terms and conditions of
135
+ this License, without any additional terms or conditions.
136
+ Notwithstanding the above, nothing herein shall supersede or modify
137
+ the terms of any separate license agreement you may have executed
138
+ with Licensor regarding such Contributions.
139
+
140
+ 6. Trademarks. This License does not grant permission to use the trade
141
+ names, trademarks, service marks, or product names of the Licensor,
142
+ except as required for reasonable and customary use in describing the
143
+ origin of the Work and reproducing the content of the NOTICE file.
144
+
145
+ 7. Disclaimer of Warranty. Unless required by applicable law or
146
+ agreed to in writing, Licensor provides the Work (and each
147
+ Contributor provides its Contributions) on an "AS IS" BASIS,
148
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
149
+ implied, including, without limitation, any warranties or conditions
150
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
151
+ PARTICULAR PURPOSE. You are solely responsible for determining the
152
+ appropriateness of using or redistributing the Work and assume any
153
+ risks associated with Your exercise of permissions under this License.
154
+
155
+ 8. Limitation of Liability. In no event and under no legal theory,
156
+ whether in tort (including negligence), contract, or otherwise,
157
+ unless required by applicable law (such as deliberate and grossly
158
+ negligent acts) or agreed to in writing, shall any Contributor be
159
+ liable to You for damages, including any direct, indirect, special,
160
+ incidental, or consequential damages of any character arising as a
161
+ result of this License or out of the use or inability to use the
162
+ Work (including but not limited to damages for loss of goodwill,
163
+ work stoppage, computer failure or malfunction, or any and all
164
+ other commercial damages or losses), even if such Contributor
165
+ has been advised of the possibility of such damages.
166
+
167
+ 9. Accepting Warranty or Additional Liability. While redistributing
168
+ the Work or Derivative Works thereof, You may choose to offer,
169
+ and charge a fee for, acceptance of support, warranty, indemnity,
170
+ or other liability obligations and/or rights consistent with this
171
+ License. However, in accepting such obligations, You may act only
172
+ on Your own behalf and on Your sole responsibility, not on behalf
173
+ of any other Contributor, and only if You agree to indemnify,
174
+ defend, and hold each Contributor harmless for any liability
175
+ incurred by, or claims asserted against, such Contributor by reason
176
+ of your accepting any such warranty or additional liability.
177
+
178
+ END OF TERMS AND CONDITIONS
179
+
180
+ APPENDIX: How to apply the Apache License to your work.
181
+
182
+ To apply the Apache License to your work, attach the following
183
+ boilerplate notice, with the fields enclosed by brackets "[]"
184
+ replaced with your own identifying information. (Don't include
185
+ the brackets!) The text should be enclosed in the appropriate
186
+ comment syntax for the file format. We also recommend that a
187
+ file or class name and description of purpose be included on the
188
+ same "printed page" as the copyright notice for easier
189
+ identification within third-party archives.
190
+
191
+ Copyright [yyyy] [name of copyright owner]
192
+
193
+ Licensed under the Apache License, Version 2.0 (the "License");
194
+ you may not use this file except in compliance with the License.
195
+ You may obtain a copy of the License at
196
+
197
+ http://www.apache.org/licenses/LICENSE-2.0
198
+
199
+ Unless required by applicable law or agreed to in writing, software
200
+ distributed under the License is distributed on an "AS IS" BASIS,
201
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
202
+ See the License for the specific language governing permissions and
203
+ limitations under the License.
@@ -0,0 +1,5 @@
1
+ include README.md
2
+ include LICENSE
3
+ # The tests need tests_data/ (4.3 MB), which the sdist leaves out, so they
4
+ # stay out too; setuptools would otherwise add tests/test*.py on its own.
5
+ prune tests
@@ -0,0 +1,165 @@
1
+ Metadata-Version: 2.4
2
+ Name: dynaface
3
+ Version: 2.1.0
4
+ Summary: Facial landmark analysis and symmetry measurement tool for facial paralysis.
5
+ Home-page: https://github.com/jeffheaton/dynaface
6
+ Author: Jeff Heaton
7
+ Author-email: jeff@jeffheaton.com
8
+ License: Apache-2.0
9
+ Project-URL: Documentation, https://docs.dynaface.org
10
+ Project-URL: Source, https://github.com/jeffheaton/dynaface
11
+ Project-URL: Bug Tracker, https://github.com/jeffheaton/dynaface/issues
12
+ Keywords: facial landmarks,symmetry,paralysis,face detection,image analysis
13
+ Classifier: Development Status :: 5 - Production/Stable
14
+ Classifier: Intended Audience :: Science/Research
15
+ Classifier: Programming Language :: Python :: 3.10
16
+ Classifier: Programming Language :: Python :: 3.11
17
+ Classifier: Programming Language :: Python :: 3.12
18
+ Classifier: Programming Language :: Python :: 3.13
19
+ Classifier: Programming Language :: Python :: 3.14
20
+ Classifier: Typing :: Typed
21
+ Classifier: Natural Language :: English
22
+ Classifier: Topic :: Scientific/Engineering :: Image Recognition
23
+ Classifier: Operating System :: OS Independent
24
+ Requires-Python: >=3.10
25
+ Description-Content-Type: text/markdown
26
+ License-File: LICENSE
27
+ Requires-Dist: opencv-python>=5.0.0
28
+ Requires-Dist: Pillow>=8.4.0
29
+ Requires-Dist: matplotlib>=3.7.1
30
+ Requires-Dist: scikit-learn>=1.2.2
31
+ Requires-Dist: onnxruntime>=1.20.0
32
+ Requires-Dist: requests>=2.25.0
33
+ Provides-Extra: test
34
+ Requires-Dist: pytest; extra == "test"
35
+ Requires-Dist: pytest-cov; extra == "test"
36
+ Requires-Dist: coverage; extra == "test"
37
+ Provides-Extra: lint
38
+ Requires-Dist: flake8; extra == "lint"
39
+ Requires-Dist: mypy; extra == "lint"
40
+ Requires-Dist: bandit; extra == "lint"
41
+ Requires-Dist: black; extra == "lint"
42
+ Requires-Dist: isort; extra == "lint"
43
+ Provides-Extra: dev
44
+ Requires-Dist: mypy; extra == "dev"
45
+ Requires-Dist: types-pillow; extra == "dev"
46
+ Requires-Dist: types-requests; extra == "dev"
47
+ Requires-Dist: types-setuptools; extra == "dev"
48
+ Requires-Dist: types-pyinstaller; extra == "dev"
49
+ Dynamic: license-file
50
+
51
+ ![Dynaface](https://s3.us-east-1.amazonaws.com/data.heatonresearch.com/dynaface/images/dynaface_logo.jpg)
52
+
53
+ # Dynaface Python Library
54
+
55
+ [![PyPI version](https://img.shields.io/pypi/v/dynaface?style=flat-square)](https://pypi.org/project/dynaface/)
56
+ [![Tests](https://img.shields.io/github/actions/workflow/status/jeffheaton/dynaface/test-lib.yml?branch=main&label=tests&style=flat-square)](https://github.com/jeffheaton/dynaface/actions/workflows/test-lib.yml)
57
+ [![Coverage](https://img.shields.io/codecov/c/github/jeffheaton/dynaface/main?flag=python&label=coverage&style=flat-square)](https://app.codecov.io/gh/jeffheaton/dynaface)
58
+ [![License](https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square)](LICENSE)
59
+ [![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/jeffheaton/dynaface/blob/main/dynaface-lib-python/examples/dynaface_intro.ipynb)
60
+
61
+ Dynaface is an AI-driven facial tracking Python Library utilizing computer vision techniques that integrate Convolutional Neural Networks (CNNs) with cascaded Graph Attention Network (GAT) regressors to enhance facial landmark detection by capturing both local appearance and global structural relationships ([Prados-Torreblanca1, A & Buenaposada, J](https://bmvc2022.mpi-inf.mpg.de/0155.pdf)). This approach encodes both the appearance and spatial positioning of facial landmarks while employing an attention mechanism to prioritize reliable information. Such a method is particularly advantageous for assessing facial asymmetry in patients with facial paralysis, where conventional landmarking algorithms are often biased toward symmetric faces. By leveraging a global representation of facial structure, Dynaface enables precise detection of key landmarks despite asymmetries, facilitating the objective quantification of facial movement and asymmetry. These measurements, including the Facial Asymmetry Index (FAI) and Oral Commissure Excursion (OCE), serve as critical indicators of facial function and can be correlated with patient-reported outcomes to evaluate recovery and patient satisfaction.
62
+
63
+ # Quick Start
64
+
65
+ Install from [PyPI](https://pypi.org/project/dynaface/):
66
+
67
+ ```bash
68
+ pip install dynaface
69
+ ```
70
+
71
+ Measure a face in a photo. The first run downloads Dynaface's AI models (about 400 MB) to `~/.dynaface/models`.
72
+
73
+ ```python
74
+ from dynaface import facial, measures, models
75
+
76
+ # Load the AI models, using a GPU or Apple silicon when one is available.
77
+ models.init_models(models.download_models(), models.detect_device())
78
+
79
+ # Find the face, crop it to a standard size and run every measure.
80
+ face = facial.load_face_image(
81
+ "https://data.heatonresearch.com/dynaface/sample/img4-1024-frontal.jpg",
82
+ measures=measures.all_measures(),
83
+ )
84
+ results = face.analyze()
85
+
86
+ # results maps each measure to its value, such as results["oce.l"] in millimeters.
87
+ print(f"Facial Asymmetry Index: {results['fai']:.2f}")
88
+
89
+ # Save the cropped face with every measure drawn on it.
90
+ face.save("face_measures.jpg")
91
+ ```
92
+
93
+ For a step-by-step walkthrough, open the [tutorial notebook](https://github.com/jeffheaton/dynaface/blob/main/dynaface-lib-python/examples/dynaface_intro.ipynb) in [Colab](https://colab.research.google.com/github/jeffheaton/dynaface/blob/main/dynaface-lib-python/examples/dynaface_intro.ipynb). The full documentation, including the API reference, is at [docs.dynaface.org](https://docs.dynaface.org).
94
+
95
+ # Helpful Links
96
+
97
+ - [Dynaface Application](https://github.com/jeffheaton/dynaface/tree/main/dynaface-app)
98
+
99
+ # Helpful Python Commands
100
+
101
+ **Activate Environment**
102
+
103
+ ```
104
+ source venv/bin/activate
105
+ .\venv\Scripts\activate.bat
106
+ .\venv\Scripts\Activate.ps1
107
+ ```
108
+
109
+ **Allow Windows to Use Environment**
110
+
111
+ ```
112
+ Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
113
+ ```
114
+
115
+ **Run Unit Tests**
116
+
117
+ For Mac/Linux:
118
+
119
+ ```
120
+ cd dynaface-lib-python
121
+ python3.11 -m venv venv
122
+ source venv/bin/activate
123
+ pip install -e ".[dev]"
124
+ python -m unittest discover -s tests
125
+ ```
126
+
127
+ For Windows:
128
+
129
+ ```
130
+ cd dynaface-lib-python
131
+ python3.11 -m venv venv
132
+ .\venv\Scripts\Activate.ps1
133
+ pip install -e ".[dev]"
134
+ python -m unittest discover -s tests
135
+ ```
136
+
137
+ ⚠️ Note for Windows users:
138
+ If you get an error like execution of scripts is disabled on this system when activating the virtual environment, you can temporarily bypass it with:
139
+
140
+ ```
141
+ Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
142
+ .\venv\Scripts\Activate.ps1
143
+ ```
144
+
145
+ # Running Examples
146
+
147
+ The [examples folder](https://github.com/jeffheaton/dynaface/tree/main/dynaface-lib-python/examples) has scripts that measure images and videos. From `dynaface-lib-python` in a clone of this repository, run them on the bundled sample files:
148
+
149
+ ```bash
150
+ # Measure a frontal photo and save it with the measures drawn on it.
151
+ python examples/process_image.py tests_data/img4-1024-frontal.jpg frontal.jpg
152
+
153
+ # Measure a side profile.
154
+ python examples/process_media.py --crop tests_data/img2-1024-right-lateral.jpg lateral.jpg
155
+
156
+ # Measure every frame of a video. This writes the annotated video-analyze.mp4,
157
+ # a chart of each measure over time (video-graph.png) and the values for every
158
+ # frame (video-data.csv).
159
+ python examples/process_media.py tests_data/video1-512.mp4 video.mp4
160
+ ```
161
+
162
+ # To Cite Dynaface
163
+
164
+ - Renne, A., Heaton, J., & Boahene, K. D. O. (2026). Associations of AI-based facial metrics with patient-reported outcomes in idiopathic facial paralysis. _Laryngoscope_. Advance online publication. https://doi.org/10.1002/lary.70417
165
+ - BibTeX: https://github.com/jeffheaton/dynaface/blob/main/CITATION.bib
@@ -0,0 +1,115 @@
1
+ ![Dynaface](https://s3.us-east-1.amazonaws.com/data.heatonresearch.com/dynaface/images/dynaface_logo.jpg)
2
+
3
+ # Dynaface Python Library
4
+
5
+ [![PyPI version](https://img.shields.io/pypi/v/dynaface?style=flat-square)](https://pypi.org/project/dynaface/)
6
+ [![Tests](https://img.shields.io/github/actions/workflow/status/jeffheaton/dynaface/test-lib.yml?branch=main&label=tests&style=flat-square)](https://github.com/jeffheaton/dynaface/actions/workflows/test-lib.yml)
7
+ [![Coverage](https://img.shields.io/codecov/c/github/jeffheaton/dynaface/main?flag=python&label=coverage&style=flat-square)](https://app.codecov.io/gh/jeffheaton/dynaface)
8
+ [![License](https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square)](LICENSE)
9
+ [![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/jeffheaton/dynaface/blob/main/dynaface-lib-python/examples/dynaface_intro.ipynb)
10
+
11
+ Dynaface is an AI-driven facial tracking Python Library utilizing computer vision techniques that integrate Convolutional Neural Networks (CNNs) with cascaded Graph Attention Network (GAT) regressors to enhance facial landmark detection by capturing both local appearance and global structural relationships ([Prados-Torreblanca1, A & Buenaposada, J](https://bmvc2022.mpi-inf.mpg.de/0155.pdf)). This approach encodes both the appearance and spatial positioning of facial landmarks while employing an attention mechanism to prioritize reliable information. Such a method is particularly advantageous for assessing facial asymmetry in patients with facial paralysis, where conventional landmarking algorithms are often biased toward symmetric faces. By leveraging a global representation of facial structure, Dynaface enables precise detection of key landmarks despite asymmetries, facilitating the objective quantification of facial movement and asymmetry. These measurements, including the Facial Asymmetry Index (FAI) and Oral Commissure Excursion (OCE), serve as critical indicators of facial function and can be correlated with patient-reported outcomes to evaluate recovery and patient satisfaction.
12
+
13
+ # Quick Start
14
+
15
+ Install from [PyPI](https://pypi.org/project/dynaface/):
16
+
17
+ ```bash
18
+ pip install dynaface
19
+ ```
20
+
21
+ Measure a face in a photo. The first run downloads Dynaface's AI models (about 400 MB) to `~/.dynaface/models`.
22
+
23
+ ```python
24
+ from dynaface import facial, measures, models
25
+
26
+ # Load the AI models, using a GPU or Apple silicon when one is available.
27
+ models.init_models(models.download_models(), models.detect_device())
28
+
29
+ # Find the face, crop it to a standard size and run every measure.
30
+ face = facial.load_face_image(
31
+ "https://data.heatonresearch.com/dynaface/sample/img4-1024-frontal.jpg",
32
+ measures=measures.all_measures(),
33
+ )
34
+ results = face.analyze()
35
+
36
+ # results maps each measure to its value, such as results["oce.l"] in millimeters.
37
+ print(f"Facial Asymmetry Index: {results['fai']:.2f}")
38
+
39
+ # Save the cropped face with every measure drawn on it.
40
+ face.save("face_measures.jpg")
41
+ ```
42
+
43
+ For a step-by-step walkthrough, open the [tutorial notebook](https://github.com/jeffheaton/dynaface/blob/main/dynaface-lib-python/examples/dynaface_intro.ipynb) in [Colab](https://colab.research.google.com/github/jeffheaton/dynaface/blob/main/dynaface-lib-python/examples/dynaface_intro.ipynb). The full documentation, including the API reference, is at [docs.dynaface.org](https://docs.dynaface.org).
44
+
45
+ # Helpful Links
46
+
47
+ - [Dynaface Application](https://github.com/jeffheaton/dynaface/tree/main/dynaface-app)
48
+
49
+ # Helpful Python Commands
50
+
51
+ **Activate Environment**
52
+
53
+ ```
54
+ source venv/bin/activate
55
+ .\venv\Scripts\activate.bat
56
+ .\venv\Scripts\Activate.ps1
57
+ ```
58
+
59
+ **Allow Windows to Use Environment**
60
+
61
+ ```
62
+ Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
63
+ ```
64
+
65
+ **Run Unit Tests**
66
+
67
+ For Mac/Linux:
68
+
69
+ ```
70
+ cd dynaface-lib-python
71
+ python3.11 -m venv venv
72
+ source venv/bin/activate
73
+ pip install -e ".[dev]"
74
+ python -m unittest discover -s tests
75
+ ```
76
+
77
+ For Windows:
78
+
79
+ ```
80
+ cd dynaface-lib-python
81
+ python3.11 -m venv venv
82
+ .\venv\Scripts\Activate.ps1
83
+ pip install -e ".[dev]"
84
+ python -m unittest discover -s tests
85
+ ```
86
+
87
+ ⚠️ Note for Windows users:
88
+ If you get an error like execution of scripts is disabled on this system when activating the virtual environment, you can temporarily bypass it with:
89
+
90
+ ```
91
+ Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
92
+ .\venv\Scripts\Activate.ps1
93
+ ```
94
+
95
+ # Running Examples
96
+
97
+ The [examples folder](https://github.com/jeffheaton/dynaface/tree/main/dynaface-lib-python/examples) has scripts that measure images and videos. From `dynaface-lib-python` in a clone of this repository, run them on the bundled sample files:
98
+
99
+ ```bash
100
+ # Measure a frontal photo and save it with the measures drawn on it.
101
+ python examples/process_image.py tests_data/img4-1024-frontal.jpg frontal.jpg
102
+
103
+ # Measure a side profile.
104
+ python examples/process_media.py --crop tests_data/img2-1024-right-lateral.jpg lateral.jpg
105
+
106
+ # Measure every frame of a video. This writes the annotated video-analyze.mp4,
107
+ # a chart of each measure over time (video-graph.png) and the values for every
108
+ # frame (video-data.csv).
109
+ python examples/process_media.py tests_data/video1-512.mp4 video.mp4
110
+ ```
111
+
112
+ # To Cite Dynaface
113
+
114
+ - Renne, A., Heaton, J., & Boahene, K. D. O. (2026). Associations of AI-based facial metrics with patient-reported outcomes in idiopathic facial paralysis. _Laryngoscope_. Advance online publication. https://doi.org/10.1002/lary.70417
115
+ - BibTeX: https://github.com/jeffheaton/dynaface/blob/main/CITATION.bib
@@ -0,0 +1,13 @@
1
+ """
2
+ Dynaface measures facial symmetry and movement in photos and videos.
3
+
4
+ Load the AI models with dynaface.models.init_models(), then analyze a face with
5
+ dynaface.facial.load_face_image() or dynaface.facial.AnalyzeFace.
6
+ """
7
+
8
+ try:
9
+ from importlib.metadata import version
10
+
11
+ __version__ = version("dynaface")
12
+ except Exception:
13
+ __version__ = "unknown"
@@ -0,0 +1,10 @@
1
+ import os
2
+ from typing import List
3
+
4
+
5
+ def get_hook_dirs() -> List[str]:
6
+ return [os.path.dirname(__file__)]
7
+
8
+
9
+ def get_PyInstaller_tests() -> List[str]:
10
+ return [os.path.dirname(__file__)]
@@ -0,0 +1,12 @@
1
+ from PyInstaller.utils.hooks import collect_data_files
2
+
3
+ # Collect data files from the specified subdirectories
4
+ datas = collect_data_files(
5
+ "dynaface", subdir="spiga/data/annotations", excludes=["__pyinstaller"]
6
+ )
7
+ datas += collect_data_files(
8
+ "dynaface", subdir="spiga/models/weights", excludes=["__pyinstaller"]
9
+ )
10
+ datas += collect_data_files(
11
+ "dynaface", subdir="spiga/data/models3D", excludes=["__pyinstaller"]
12
+ )