Shortcuts

Installation & Troubleshooting

Installation options

Install with pip

pip install lightning-flash

Optionally, you can install Flash with extra packages for each domain.

For a single domain, use: pip install 'lightning-flash[{DOMAIN}]'.

pip install 'lightning-flash[image]'
pip install 'lightning-flash[tabular]'
pip install 'lightning-flash[text]'
...

For multiple domains, use: pip install 'lightning-flash[{DOMAIN_1, DOMAIN_2, ...}]'.

pip install 'lightning-flash[audio,image]'
...

For contributors, please install Flash with packages for testing Flash and building docs.

# Clone Flash repository locally
git clone https://github.com/[your username]/lightning-flash.git
cd lightning-flash

# Install Flash in editable mode with extra packages for development
pip install -e '.[dev]'

Install with conda

Flash is available via conda forge. Install it with:

conda install -c conda-forge lightning-flash

Install from source

You can install Flash from source without any domain specific dependencies with:

pip install 'git+https://github.com/PyTorchLightning/lightning-flash.git'

To install Flash with domain dependencies, use:

pip install 'git+https://github.com/PyTorchLightning/lightning-flash.git#egg=lightning-flash[image]'

You can again install dependencies for multiple domains by separating them with commas as above.

Troubleshooting

Torchtext incompatibility

If you install Flash in an environment that already has a version of torchtext installed, you may see an error like this when you try to import it:

ImportError: /usr/local/lib/python3.7/dist-packages/torchtext/_torchtext.so: undefined symbol: _ZN2at6detail10noopDeleteEPv

The workaround is to uninstall torchtext before installing Flash, like this:

pip uninstall -y torchtext
pip install lightning-flash[...]

FiftyOne incompatibility on Google Colab

When installing Flash (or PyTorch Lightning) alongside FiftyOne in a Google Colab environment, you may get the following error when importing FiftyOne:

ServiceListenTimeout: fiftyone.core.service.DatabaseService failed to bind to port

There is no known workaround for this issue at the time of writing, but you can view the latest updates on the associated github issue.

Read the Docs v: latest
Versions
latest
stable
0.7.4
0.7.3
0.7.2
0.7.1
0.7.0
0.6.0
0.5.2
0.5.1
0.5.0
0.4.0
0.3.2
0.3.1
0.3.0
0.2.3
0.2.2
0.2.1
0.2.0
0.1.0post1
docs-fix_typing
Downloads
html
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.