Rename DataSource to Input (#929)

Co-authored-by: Ethan Harris <ethanwharris@gmail.com>
Lightning-Universe · Nov 10, 2021 · e983c1e · e983c1e
1 parent 00ef240
commit e983c1e
Show file tree

Hide file tree

Showing 129 changed files with 2,046 additions and 1,974 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,6 +14,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 
 ### Changed
 
+- Changed `DataSource` to `Input` ([#929](https://github.com/PyTorchLightning/lightning-flash/pull/929))
+
 - Changed `Preprocess` to `InputTransform` ([#951](https://github.com/PyTorchLightning/lightning-flash/pull/951))
 
 - Changed classes named `*Serializer` and properties / variables named `serializer` to be `*Output` and `output` respectively ([#927](https://github.com/PyTorchLightning/lightning-flash/pull/927))
@@ -30,6 +32,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 
 - Deprecated `flash.text.seq2seq.core.metrics` in favour of `torchmetrics[text]` ([#648](https://github.com/PyTorchLightning/lightning-flash/pull/648))
 
+- Deprecated `flash.core.data.data_source.DefaultDataKeys` in favour of `flash.DataKeys` ([#929](https://github.com/PyTorchLightning/lightning-flash/pull/929))
+
+- Deprecated `data_source` argument to `flash.Task.predict` in favour of `input` ([#929](https://github.com/PyTorchLightning/lightning-flash/pull/929))
+
 ### Fixed
 
 ### Removed

diff --git a/docs/extensions/autodatasources.py b/docs/extensions/autodatasources.py
@@ -61,17 +61,14 @@ def _resolve_transforms(_):
                 return None
 
         input_transform = PatchedInputTransform()
-        data_sources = {
-            data_source: input_transform.data_source_of_name(data_source)
-            for data_source in input_transform.available_data_sources()
-        }
+        inputs = {input: input_transform.input_of_name(input) for input in input_transform.available_inputs()}
 
         ENVIRONMENT.get_template("base.rst")
 
         rendered_content = ENVIRONMENT.get_template(data_module_name).render(
             data_module=f":class:`~{data_module_path}.{data_module_name}`",
             data_module_raw=data_module_name,
-            data_sources=data_sources,
+            inputs=inputs,
         )
 
         node = nodes.section()

diff --git a/docs/extensions/templates/base.rst b/docs/extensions/templates/base.rst
@@ -7,15 +7,15 @@
 
 This section details the available ways to load your own data into the {{ data_module }}.
 
-{% if 'folders' in data_sources %}
+{% if 'folders' in inputs %}
 {% call render_subsection('from_folders') %}
 
 {% block from_folders %}
 Construct the {{ data_module }} from folders.
 
-{% if data_sources['folders'].extensions is defined %}
-The supported file extensions are: {{ data_sources['folders'].extensions|join(', ') }}.
-{% set extension = data_sources['folders'].extensions[0] %}
+{% if inputs['folders'].extensions is defined %}
+The supported file extensions are: {{ inputs['folders'].extensions|join(', ') }}.
+{% set extension = inputs['folders'].extensions[0] %}
 {% else %}
 {% set extension = '' %}
 {% endif %}
@@ -54,15 +54,15 @@ Example::
 {% endblock %}
 {% endcall %}
 {% endif %}
-{% if 'files' in data_sources %}
+{% if 'files' in inputs %}
 {% call render_subsection('from_files') %}
 
 {% block from_files %}
 Construct the {{ data_module }} from lists of files and corresponding lists of targets.
 
-{% if data_sources['files'].extensions is defined %}
-The supported file extensions are: {{ data_sources['files'].extensions|join(', ') }}.
-{% set extension = data_sources['files'].extensions[0] %}
+{% if inputs['files'].extensions is defined %}
+The supported file extensions are: {{ inputs['files'].extensions|join(', ') }}.
+{% set extension = inputs['files'].extensions[0] %}
 {% else %}
 {% set extension = '' %}
 {% endif %}
@@ -80,7 +80,7 @@ Example::
 {% endblock %}
 {% endcall %}
 {% endif %}
-{% if 'datasets' in data_sources %}
+{% if 'datasets' in inputs %}
 {% call render_subsection('from_datasets') %}
 
 {% block from_datasets %}

diff --git a/docs/source/api/audio.rst b/docs/source/api/audio.rst
@@ -34,10 +34,10 @@ __________________
     speech_recognition.data.SpeechRecognitionInputTransform
     speech_recognition.data.SpeechRecognitionBackboneState
     speech_recognition.data.SpeechRecognitionOutputTransform
-    speech_recognition.data.SpeechRecognitionCSVDataSource
-    speech_recognition.data.SpeechRecognitionJSONDataSource
+    speech_recognition.data.SpeechRecognitionCSVInput
+    speech_recognition.data.SpeechRecognitionJSONInput
     speech_recognition.data.BaseSpeechRecognition
-    speech_recognition.data.SpeechRecognitionFileDataSource
-    speech_recognition.data.SpeechRecognitionPathsDataSource
-    speech_recognition.data.SpeechRecognitionDatasetDataSource
+    speech_recognition.data.SpeechRecognitionFileInput
+    speech_recognition.data.SpeechRecognitionPathsInput
+    speech_recognition.data.SpeechRecognitionDatasetInput
     speech_recognition.data.SpeechRecognitionDeserializer
diff --git a/docs/source/api/data.rst b/docs/source/api/data.rst
@@ -81,34 +81,34 @@ _____________________________
     ~flash.core.data.data_pipeline.DataPipeline
     ~flash.core.data.data_pipeline.DataPipelineState
 
-flash.core.data.data_source
+flash.core.data.io.input
 ___________________________
 
 .. autosummary::
     :toctree: generated/
     :nosignatures:
     :template: classtemplate.rst
 
-    ~flash.core.data.data_source.DatasetDataSource
-    ~flash.core.data.data_source.DataSource
-    ~flash.core.data.data_source.DefaultDataKeys
-    ~flash.core.data.data_source.DefaultDataSources
-    ~flash.core.data.data_source.FiftyOneDataSource
-    ~flash.core.data.data_source.ImageLabelsMap
-    ~flash.core.data.data_source.LabelsState
-    ~flash.core.data.data_source.MockDataset
-    ~flash.core.data.data_source.NumpyDataSource
-    ~flash.core.data.data_source.PathsDataSource
-    ~flash.core.data.data_source.SequenceDataSource
-    ~flash.core.data.data_source.TensorDataSource
+    ~flash.core.data.io.input.DatasetInput
+    ~flash.core.data.io.input.Input
+    ~flash.core.data.io.input.DataKeys
+    ~flash.core.data.io.input.InputFormat
+    ~flash.core.data.io.input.FiftyOneInput
+    ~flash.core.data.io.input.ImageLabelsMap
+    ~flash.core.data.io.input.LabelsState
+    ~flash.core.data.io.input.MockDataset
+    ~flash.core.data.io.input.NumpyInput
+    ~flash.core.data.io.input.PathsInput
+    ~flash.core.data.io.input.SequenceInput
+    ~flash.core.data.io.input.TensorInput
 
 .. autosummary::
     :toctree: generated/
     :nosignatures:
 
-    ~flash.core.data.data_source.has_file_allowed_extension
-    ~flash.core.data.data_source.has_len
-    ~flash.core.data.data_source.make_dataset
+    ~flash.core.data.io.input.has_file_allowed_extension
+    ~flash.core.data.io.input.has_len
+    ~flash.core.data.io.input.make_dataset
 
 flash.core.data.process
 _______________________

diff --git a/docs/source/api/flash.rst b/docs/source/api/flash.rst
@@ -7,7 +7,7 @@ flash
     :nosignatures:
     :template: classtemplate.rst
 
-    ~flash.core.data.data_source.DataSource
+    ~flash.core.data.io.input.Input
     ~flash.core.data.data_module.DataModule
     ~flash.core.data.callback.FlashCallback
     ~flash.core.data.io.output_transform.OutputTransform

diff --git a/docs/source/api/graph.rst b/docs/source/api/graph.rst
@@ -40,4 +40,4 @@ ________________
     :nosignatures:
     :template: classtemplate.rst
 
-    ~data.GraphDatasetDataSource
+    ~data.GraphDatasetInput
diff --git a/docs/source/api/image.rst b/docs/source/api/image.rst
@@ -43,7 +43,7 @@ ________________
     ~detection.data.ObjectDetectionData
 
     detection.data.FiftyOneParser
-    detection.data.ObjectDetectionFiftyOneDataSource
+    detection.data.ObjectDetectionFiftyOneInput
     detection.output.FiftyOneDetectionLabels
     detection.data.ObjectDetectionInputTransform
 
@@ -96,10 +96,10 @@ ____________
     ~segmentation.data.SemanticSegmentationInputTransform
 
     segmentation.data.SegmentationMatplotlibVisualization
-    segmentation.data.SemanticSegmentationNumpyDataSource
-    segmentation.data.SemanticSegmentationTensorDataSource
-    segmentation.data.SemanticSegmentationPathsDataSource
-    segmentation.data.SemanticSegmentationFiftyOneDataSource
+    segmentation.data.SemanticSegmentationNumpyInput
+    segmentation.data.SemanticSegmentationTensorInput
+    segmentation.data.SemanticSegmentationPathsInput
+    segmentation.data.SemanticSegmentationFiftyOneInput
     segmentation.data.SemanticSegmentationDeserializer
     segmentation.model.SemanticSegmentationOutputTransform
     segmentation.output.FiftyOneSegmentationLabels
@@ -140,7 +140,7 @@ ________________
     :template: classtemplate.rst
 
     ~data.ImageDeserializer
-    ~data.ImageFiftyOneDataSource
-    ~data.ImageNumpyDataSource
-    ~data.ImagePathsDataSource
-    ~data.ImageTensorDataSource
+    ~data.ImageFiftyOneInput
+    ~data.ImageNumpyInput
+    ~data.ImagePathsInput
+    ~data.ImageTensorInput
diff --git a/docs/source/api/pointcloud.rst b/docs/source/api/pointcloud.rst
@@ -21,8 +21,8 @@ ____________
     ~segmentation.data.PointCloudSegmentationData
 
     segmentation.data.PointCloudSegmentationInputTransform
-    segmentation.data.PointCloudSegmentationFoldersDataSource
-    segmentation.data.PointCloudSegmentationDatasetDataSource
+    segmentation.data.PointCloudSegmentationFoldersInput
+    segmentation.data.PointCloudSegmentationDatasetInput
 
 Object Detection
 ________________
@@ -36,5 +36,5 @@ ________________
     ~detection.data.PointCloudObjectDetectorData
 
     detection.data.PointCloudObjectDetectorInputTransform
-    detection.data.PointCloudObjectDetectorFoldersDataSource
-    detection.data.PointCloudObjectDetectorDatasetDataSource
+    detection.data.PointCloudObjectDetectorFoldersInput
+    detection.data.PointCloudObjectDetectorDatasetInput
diff --git a/docs/source/api/tabular.rst b/docs/source/api/tabular.rst
@@ -43,7 +43,7 @@ ___________
     ~forecasting.data.TabularForecastingData
 
     forecasting.data.TabularForecastingInputTransform
-    forecasting.data.TabularForecastingDataFrameDataSource
+    forecasting.data.TabularForecastingDataFrameInput
     forecasting.data.TimeSeriesDataSetParametersState
 
 flash.tabular.data
@@ -55,8 +55,8 @@ __________________
     :template: classtemplate.rst
 
     ~data.TabularData
-    ~data.TabularDataFrameDataSource
-    ~data.TabularCSVDataSource
+    ~data.TabularDataFrameInput
+    ~data.TabularCSVInput
     ~data.TabularDeserializer
     ~data.TabularOutputTransform
     ~data.TabularInputTransform
diff --git a/docs/source/api/text.rst b/docs/source/api/text.rst
@@ -23,13 +23,13 @@ ______________
     classification.data.TextClassificationOutputTransform
     classification.data.TextClassificationInputTransform
     classification.data.TextDeserializer
-    classification.data.TextDataSource
-    classification.data.TextCSVDataSource
-    classification.data.TextJSONDataSource
-    classification.data.TextDataFrameDataSource
-    classification.data.TextParquetDataSource
-    classification.data.TextHuggingFaceDatasetDataSource
-    classification.data.TextListDataSource
+    classification.data.TextInput
+    classification.data.TextCSVInput
+    classification.data.TextJSONInput
+    classification.data.TextDataFrameInput
+    classification.data.TextParquetInput
+    classification.data.TextHuggingFaceDatasetInput
+    classification.data.TextListInput
 
 Question Answering
 __________________
@@ -43,15 +43,14 @@ __________________
     ~question_answering.data.QuestionAnsweringData
 
     question_answering.data.QuestionAnsweringBackboneState
-    question_answering.data.QuestionAnsweringCSVDataSource
-    question_answering.data.QuestionAnsweringDataSource
-    question_answering.data.QuestionAnsweringDictionaryDataSource
-    question_answering.data.QuestionAnsweringFileDataSource
-    question_answering.data.QuestionAnsweringJSONDataSource
+    question_answering.data.QuestionAnsweringCSVInput
+    question_answering.data.QuestionAnsweringInput
+    question_answering.data.QuestionAnsweringDictionaryInput
+    question_answering.data.QuestionAnsweringFileInput
+    question_answering.data.QuestionAnsweringJSONInput
     question_answering.data.QuestionAnsweringOutputTransform
     question_answering.data.QuestionAnsweringInputTransform
-    question_answering.data.SQuADDataSource
-
+    question_answering.data.SQuADInput
 
 Summarization
 _____________
@@ -92,10 +91,11 @@ _______________
     ~seq2seq.core.finetuning.Seq2SeqFreezeEmbeddings
 
     seq2seq.core.data.Seq2SeqBackboneState
-    seq2seq.core.data.Seq2SeqCSVDataSource
-    seq2seq.core.data.Seq2SeqDataSource
-    seq2seq.core.data.Seq2SeqFileDataSource
-    seq2seq.core.data.Seq2SeqJSONDataSource
+    seq2seq.core.data.Seq2SeqCSVInput
+    seq2seq.core.data.Seq2SeqInput
+    seq2seq.core.data.Seq2SeqFileInput
+    seq2seq.core.data.Seq2SeqJSONInput
     seq2seq.core.data.Seq2SeqOutputTransform
     seq2seq.core.data.Seq2SeqInputTransform
-    seq2seq.core.data.Seq2SeqSentencesDataSource
+    seq2seq.core.data.Seq2SeqSentencesInput
+    seq2seq.core.metrics.BLEUScore
diff --git a/docs/source/api/video.rst b/docs/source/api/video.rst
@@ -21,7 +21,7 @@ ______________
     ~classification.data.VideoClassificationData
 
     classification.data.BaseVideoClassification
-    classification.data.VideoClassificationFiftyOneDataSource
-    classification.data.VideoClassificationPathsDataSource
+    classification.data.VideoClassificationFiftyOneInput
+    classification.data.VideoClassificationPathsInput
     classification.data.VideoClassificationInputTransform
     classification.model.VideoClassifierFinetuning