Skip to main content

Generate holograms from text

Project description

text2hologram

text2hologram is a Python package designed to generate holograms from text. It's built on top of the odak, timm, transformers, diffusers, accelerate, and torch libraries.

text2hologram supports Python 3.9 and above.

The project's source code is available here.

Installation

To install the package, use the following pip command:

pip install text2hologram

Usage

You can use the package from the command line with the text2hologram command.

Here is a simple usage example:

text2hologram --device 'cuda' --outputdir './output'

The command above checks the device first,and then ask for a text input. generates a hologram from the input text using GPU and saves the output in the './output' directory.

Here's a brief description of each option:

  • --device : Computation device to use. Can be 'cpu' or 'cuda'.
  • --outputdir : Directory to save output files.
  • --inference_steps : Inference steps to generate an image. A higher number of inference steps will result in a more accurate and detailed image, but increase the computational cost and time required.

See more settings in config.json. All settings are named in a self-explanatory manner.

License

text2hologram is licensed under the MIT license. The terms of the license can be found in the LICENSE file.

Contact

For any questions or feedback, you are welcome to reach out to Pengze Li at linsonng@163.com.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

text2hologram-0.1.5.3.tar.gz (13.3 kB view hashes)

Uploaded Source

Built Distribution

text2hologram-0.1.5.3-py3-none-any.whl (15.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page