mflux-taef 0.1.0__tar.gz

mflux_taef-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file type. We recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Denis Ineshin
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

mflux_taef-0.1.0/NOTICE

@@ -0,0 +1,53 @@
+mflux-taef
+Copyright 2026 the mflux-plugins contributors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+------------------------------------------------------------------------------
+Third-party attributions
+------------------------------------------------------------------------------
+
+This product includes software derived from mflux
+(https://github.com/mflux-community/mflux), licensed under MIT License:
+
+  MIT License
+
+  Copyright (c) 2026 Filip Strand
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in all
+  copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+  SOFTWARE.
+
+  src/mflux/extras/taef/z_image.py (warn_ineffective_options) copies a
+  block of statements from main() in mflux's
+  src/mflux/models/z_image/cli/z_image_generate.py.
+
+  src/mflux/extras/taef/z_image_turbo.py (warn_before_load) copies
+  statements from main() in mflux's
+  src/mflux/models/z_image/cli/z_image_turbo_generate.py.
+
+  src/mflux/extras/taef/_core.py (_is_hf_format) copies the
+  PathResolution._is_hf_format check from mflux's
+  src/mflux/models/common/resolution/path_resolution.py.
+
+  src/mflux/extras/taef/_core.py (_option_was_provided) copies the
+  CommandLineParser._option_was_provided argv scan from mflux's
+  src/mflux/cli/parser/parsers.py.

mflux_taef-0.1.0/PKG-INFO

@@ -0,0 +1,252 @@
+Metadata-Version: 2.4
+Name: mflux-taef
+Version: 0.1.0
+Summary: Live TAEF previews for mflux's command line, powered by mlx-taef.
+Keywords: mflux,mlx,taef,preview,apple-silicon,diffusion,z-image
+Author: Denis Ineshin
+Author-email: Denis Ineshin <denis.ineshin@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: mlx-taef[mflux]>=0.9.0
+Requires-Dist: mflux>=0.24
+Maintainer: Denis Ineshin
+Maintainer-email: Denis Ineshin <denis.ineshin@gmail.com>
+Requires-Python: >=3.11
+Project-URL: Homepage, https://github.com/mflux-community/mflux-plugins/tree/main/taef
+Project-URL: Repository, https://github.com/mflux-community/mflux-plugins
+Project-URL: Issues, https://github.com/mflux-community/mflux-plugins/issues
+Project-URL: Documentation, https://github.com/mflux-community/mflux-plugins/tree/main/taef#readme
+Description-Content-Type: text/markdown
+
+# mflux-taef
+
+Adds two commands to [mflux](https://github.com/mflux-community/mflux): `mflux-generate-z-image-turbo-taef` and
+`mflux-generate-z-image-taef`. Each takes every option of the mflux command it mirrors
+(`mflux-generate-z-image-turbo` and `mflux-generate-z-image`), runs mflux's own loading and generation steps, and
+writes a live preview image while the picture is being denoised. Open the file in Preview or Quick Look, and press
+Ctrl-C when the composition is wrong instead of waiting for the last step.
+
+The preview is the image as it stands after the current step, decoded by a tiny decoder from
+[mlx-taef](https://github.com/IonDen/mlx-taef). It is not the final image, which mflux still decodes with the model's
+own VAE and saves the usual way.
+
+mflux-taef lives in the `taef/` folder of [mflux-plugins](https://github.com/mflux-community/mflux-plugins), the plugin
+repository of the mflux-community organization. Denis Ineshin maintains it. The tiny decoder is in mlx-taef, a separate
+Python library by the same author; this package connects it to mflux's command line.
+[Versions](#versions) lists what it installs with.
+
+## Install
+
+The recommended setup puts mflux and this package in one tool environment:
+
+```bash
+uv tool install mflux --with-executables-from mflux-taef
+```
+
+You get mflux's commands and the two TAEF commands side by side. In a virtual environment that already has mflux:
+
+```bash
+pip install mflux-taef
+```
+
+Installing the package brings in mlx-taef. The first run downloads the decoder and converts it for MLX;
+later runs reuse it.
+
+## Usage
+
+Use the Turbo command for Turbo; the base command runs both.
+
+```bash
+mflux-generate-z-image-turbo-taef --prompt "a lighthouse on a cliff at dusk" --steps 8 --seed 42
+```
+
+Every `mflux-generate-z-image-turbo` option works the same way. For Z-Image base:
+
+```bash
+mflux-generate-z-image-taef --prompt "a lighthouse on a cliff at dusk" --steps 50 --guidance 4.0 --seed 42
+```
+
+Before each image the command prints where its preview goes, for example
+`TAEF preview: image.preview.png, every step (zimage decoder)`.
+
+Three options control the preview:
+
+| Option | Default | What it does |
+|---|---|---|
+| `--taef-preview PATH` | `<output name>.preview.png`, next to the output image | Where the preview goes: a `.png`, `.jpg`, `.jpeg` or `.webp` file (any letter case). `PATH` may contain `{seed}`. |
+| `--taef-every N` | every step | Update the preview every `N` steps; `N` is 1 or more. |
+| `--taef-frames` | off | Keep every step as its own file, `<preview name>_stepNN.<suffix>`. |
+
+`--taef-frames` writes every step, so it can't be combined with `--taef-every`. `NN` counts the steps this run
+executed, so an image-to-image run, which starts partway through the schedule, numbers from its own first step.
+
+### Where the files go
+
+By default the preview sits next to the final image: for `--output out.png` it is `out.preview.png`. With several
+seeds, mflux adds `_seed_<n>` to the output name, so the previews get it too.
+
+An explicit `--taef-preview PATH` is one live file, and each seed overwrites it in turn, so reopen the file to see the
+latest preview. Put `{seed}` in `PATH` to get one file per seed instead. With `--taef-frames` and several seeds,
+`_seed_<n>` is added to the end of the name, so each seed keeps its own `..._seed_<n>_stepNN...` files. The line the
+command prints before each seed shows the real path for that seed.
+
+### Previews and `--stepwise-image-output-dir`
+
+mflux's `--stepwise-image-output-dir` decodes every step with the model's full VAE and keeps every step plus a
+composite image. A preview goes through the tiny decoder into one file. mlx-taef's
+[comparison page](https://github.com/IonDen/mlx-taef/blob/main/COMPARISON.md) has the published decode speed and the
+similarity to the full VAE for Z-Image; this package adds no timing figure of its own.
+
+The two options can run in the same command: mflux writes its step images to its directory and this package writes the
+preview file or frames to the preview path.
+
+## Checked on real weights
+
+On 2026-11-09 the TAEF commands below ran on real weights, and the single-seed 512×512 ones were compared with the
+plain mflux command with the same options. The machine was an Apple M1 Max with 32 GB, macOS 27.2, Python 3.13,
+mflux 0.24.0 and mlx-taef 0.9.0. The prompt was "a red apple on a wooden table" and the seed 42. The models were
+`mflux-community/z-image-turbo-mflux-q4` and `mflux-community/z-image-base-mflux-q4`. The first two lines are the plain
+commands the TAEF images were compared with; the rest are the TAEF commands:
+
+```bash
+mflux-generate-z-image-turbo --model mflux-community/z-image-turbo-mflux-q4 --prompt "a red apple on a wooden table" --steps 8 --seed 42 --width 512 --height 512 --output image.png
+mflux-generate-z-image --model mflux-community/z-image-base-mflux-q4 --base-model z-image --prompt "a red apple on a wooden table" --steps 20 --guidance 4.0 --low-ram --seed 42 --width 512 --height 512 --output image.png
+mflux-generate-z-image-turbo-taef --model mflux-community/z-image-turbo-mflux-q4 --prompt "a red apple on a wooden table" --steps 8 --seed 42 --width 512 --height 512 --output image.png
+mflux-generate-z-image-turbo-taef --model mflux-community/z-image-turbo-mflux-q4 --prompt "a red apple on a wooden table" --steps 8 --seed 42 --width 512 --height 512 --output image.png --taef-frames
+mflux-generate-z-image-turbo-taef --model mflux-community/z-image-turbo-mflux-q4 --prompt "a red apple on a wooden table" --steps 8 --seed 42 43 --width 512 --height 512 --output image.png
+mflux-generate-z-image-taef --model mflux-community/z-image-base-mflux-q4 --base-model z-image --prompt "a red apple on a wooden table" --steps 20 --guidance 4.0 --low-ram --seed 42 --width 512 --height 512 --output image.png --taef-every 5
+mflux-generate-z-image-taef --model mflux-community/z-image-base-mflux-q4 --base-model z-image --prompt "a red apple on a wooden table" --steps 8 --guidance 4.0 --seed 42 --width 1024 --height 1024 --output image.png
+```
+
+- Turbo, 512×512: the TAEF image was pixel-identical to the plain one, and a 512×512 preview was written. With
+  `--taef-frames` the image was identical again, and 8 per-step preview files were written instead of the single
+  preview.
+- Turbo with `--seed 42 43`: the seed-42 image was identical to the single-seed plain image, and each seed got its own
+  preview.
+- Base, 512×512, with `--low-ram` and `--taef-every 5`: the image was identical to the plain one, and a preview was
+  written.
+- Base, 1024×1024: the TAEF command finished and wrote the image and a 1024×1024 preview. There was no plain run of
+  that recipe, so there is no comparison.
+- Ctrl-C after step 3 of 8 (the Turbo 512×512 TAEF command): mflux printed "Stopping image generation at step", the
+  exit code was 0, no image was written, and the preview stayed on disk.
+
+In the single-image 512×512 Turbo runs above, the TAEF command used more memory than the plain one; that is one
+comparison on one machine. The TAEF Turbo command was also started at 1024×1024 and did not finish in this test, so nothing here covers
+Turbo at that size.
+
+## What the command checks
+
+The command checks your request before it loads any weights. When it can't run, it stops with exit code 2 and a message
+that says why. These refusals also tell you to run the plain mflux command to generate without previews:
+
+- `--taef-every` below 1;
+- a preview file that doesn't end in `.png`, `.jpg`, `.jpeg` or `.webp`;
+- a `--taef-preview` with a `{...}` field other than `{seed}`, or a `{seed}` field with more than a width. `{seed}`
+  takes a width of one to three digits (padded with spaces, or with zeros when it starts with 0), optionally followed
+  by `d`, so `{seed:04d}` and `{seed:3}` run. A conversion such as `{seed!r}`, a bare `{seed:d}`, any other spec and a
+  width of more than three digits (`{seed:0004}` included) are refused.
+
+These refusals only explain the problem:
+
+- `--taef-every` together with `--taef-frames`;
+- a `--taef-preview` path that is an existing directory or a symbolic link. The check runs before anything loads. With
+  `--taef-frames` the same goes for an existing directory or symbolic link at any `<preview name>_stepNN.<suffix>`
+  frame name in the preview's folder;
+- a preview file name over 255 bytes, which is the most a file name can have. A `{seed:999}` width can reach that. With
+  `--taef-frames` the longest frame name is measured. Without this check the model would load and the first save would
+  fail, which turns the preview off;
+- a preview path that names the same file as `--output`, or, with several seeds, as any seed's output (for example
+  `--seed 2 12 --output a.png --taef-preview 'a_seed_1{seed}.png'`). The match ignores letter case, because a default
+  macOS volume does. With `--taef-frames` the preview path itself is never written, so `--output` is compared with the
+  `<preview name>_stepNN.<suffix>` frame names instead. Without this check the last preview would take the name, and
+  mflux would save the final image under another one;
+- a `--model` that is not one of mflux's names, not a local path that exists and not a Hugging Face repo id
+  (`org/model`). On an mflux whose model-path rules differ from the checked release, the name is left to mflux. A
+  missing path restored with `-C` names the file it came from;
+- anything mflux's own option checks refuse, with mflux's own message.
+
+Exit codes:
+
+- 0: the run finished, you pressed Ctrl-C during generation (the last preview stays on disk), or the prompt file
+  couldn't be read.
+- 1: the decoder couldn't be prepared (checked before the model loads; it prints `could not prepare the TAEF preview
+  decoder`), or the run failed after the model loaded (the traceback is printed).
+- 2: the request was refused before any weights loaded.
+
+If a preview fails during a run (a decode error, a folder you can't write to), the command prints one warning on
+stderr, stops previews for that seed and finishes the image. The plugin writes nothing into the image's metadata or the
+`--make-conf` sidecar, so the final image's metadata is what the plain command writes.
+
+## What it doesn't do
+
+- No fast final decode. The tiny decoder is for previews; the saved image still uses the model's VAE. mflux's own
+  `--low-ram` stays the option for decode memory. mflux decodes in row strips by default, and `--vae-full-precision`
+  switches that off.
+- No composite image, GIF or video, no terminal or window display, and no record in the image's metadata.
+- No prediction previews for Z-Image: mflux doesn't pass the model's prediction to Z-Image callbacks, so the preview
+  decodes the latent.
+- No FLUX.1, FLUX.2, Qwen-Image or other model families yet (Qwen-Image 2.1 included).
+- No command that combines TAEF with TeaCache (see the next section).
+
+## With mflux-teacache
+
+The two plugins install into one environment, because each adds only its own part of the `mflux.extras` namespace:
+
+```bash
+pip install mflux-taef mflux-teacache
+```
+
+They don't combine on the command line: `mflux-generate-z-image-teacache` has no `--taef-preview`, and the TAEF
+commands don't skip steps. The libraries do work together from Python. TeaCache supports Z-Image base, not Turbo:
+
+```python
+from pathlib import Path
+
+from mflux.models.common.config.model_config import ModelConfig
+from mflux.models.z_image.variants.z_image import ZImage
+from mlx_taef.integrations.mflux import LivePreviewCallback
+from mlx_teacache import apply_teacache
+
+model = ZImage(model_config=ModelConfig.z_image(), quantize=8)
+handle = apply_teacache(model)
+preview = LivePreviewCallback(flux=model, every=1, save_to=Path("preview.png"))
+model.callbacks.register(preview)
+image = model.generate_image(
+    seed=42, prompt="a lighthouse on a cliff at dusk", width=512, height=512, guidance=4.0, num_inference_steps=50
+)
+image.save("out.png")
+```
+
+## Versions
+
+- Python 3.11 or newer, on Apple Silicon.
+- mflux 0.24 or newer, with no upper limit.
+- mlx-taef 0.9.0 or newer.
+
+What changed in each release is in
+[CHANGELOG.md](https://github.com/mflux-community/mflux-plugins/blob/main/taef/CHANGELOG.md).
+
+## Development
+
+From the `taef/` folder of an mflux-plugins checkout:
+
+```bash
+uv sync --locked
+uv run pytest
+uv run ruff check . && uv run ruff format --check .
+uv run ty check src
+```
+
+The tests use stand-ins for the model and a random decoder, and never download weights. `AGENTS.md` describes the
+package layout and its rules.
+
+## License
+
+Apache-2.0. `NOTICE` lists the code this package copies from mflux, which is MIT-licensed.