optional.rst

Optional Extras

Organize your transforms in transforms.py

It can be useful to define your :class:`~flash.core.data.io.input_transform.InputTransform` in an input_transform.py file. Here's an example from image/classification/input_transform.py:

.. literalinclude:: ../../../src/flash/image/classification/input_transform.py
    :language: python
    :pyobject: ImageClassificationInputTransform

Add outputs to your Task

We recommend that you do most of the heavy lifting in the :class:`~flash.core.data.io.output_transform.OutputTransform`. Specifically, it should include any formatting and transforms that should always be applied to the predictions. If you want to support different use cases that require different prediction formats, you should add some :class:`~flash.core.data.io.output.Output` implementations in an output.py file.

Some good examples are in flash/core/classification.py. Here's the :class:`~flash.core.classification.ClassesOutput` :class:`~flash.core.data.io.output.Output`:

.. literalinclude:: ../../../src/flash/core/classification.py
    :language: python
    :pyobject: ClassesOutput

Alternatively, here's the :class:`~flash.core.classification.LogitsOutput` :class:`~flash.core.data.io.output.Output`:

.. literalinclude:: ../../../src/flash/core/classification.py
    :language: python
    :pyobject: LogitsOutput

Take a look at :ref:`predictions` to learn more.

---

Once you've added any optional extras, it's time to :ref:`create some examples showing your task in action! <contributing_examples>`