Simplify imports in 'Features Extraction' documentation examples

Author: mimi030

docs/readme/examples_source/extractor/retrieval_usage.md

@@ -7,11 +7,11 @@
 import torch
 
 from oml.const import MOCK_DATASET_PATH
-from oml.inference.flat import inference_on_images
+from oml.inference import inference_on_images
 from oml.models import ViTExtractor
-from oml.registry.transforms import get_transforms_for_pretrained
-from oml.utils.download_mock_dataset import download_mock_dataset
-from oml.utils.misc_torch import pairwise_dist
+from oml.registry import get_transforms_for_pretrained
+from oml.utils import download_mock_dataset
+from oml.utils import pairwise_dist
 
 _, df_val = download_mock_dataset(MOCK_DATASET_PATH)
 df_val["path"] = df_val["path"].apply(lambda x: MOCK_DATASET_PATH / x)

docs/readme/examples_source/extractor/train.md

@@ -7,12 +7,12 @@
 import torch
 from tqdm import tqdm
 
-from oml.datasets.base import DatasetWithLabels
-from oml.losses.triplet import TripletLossWithMiner
-from oml.miners.inbatch_all_tri import AllTripletsMiner
+from oml.datasets import DatasetWithLabels
+from oml.losses import TripletLossWithMiner
+from oml.miners import AllTripletsMiner
 from oml.models import ViTExtractor
-from oml.samplers.balance import BalanceSampler
-from oml.utils.download_mock_dataset import download_mock_dataset
+from oml.samplers import BalanceSampler
+from oml.utils import download_mock_dataset
 
 dataset_root = "mock_dataset/"
 df_train, _ = download_mock_dataset(dataset_root)

docs/readme/examples_source/extractor/train_2loaders_val.md

@@ -7,13 +7,13 @@
 import pytorch_lightning as pl
 import torch
 
-from oml.datasets.base import DatasetQueryGallery
-from oml.lightning.callbacks.metric import MetricValCallback
-from oml.lightning.modules.extractor import ExtractorModule
-from oml.metrics.embeddings import EmbeddingMetrics
+from oml.datasets import DatasetQueryGallery
+from oml.lightning import MetricValCallback
+from oml.lightning import ExtractorModule
+from oml.metrics import EmbeddingMetrics
 from oml.models import ViTExtractor
-from oml.transforms.images.torchvision import get_normalisation_resize_torch
-from oml.utils.download_mock_dataset import download_mock_dataset
+from oml.transforms import get_normalisation_resize_torch
+from oml.utils import download_mock_dataset
 
 dataset_root = "mock_dataset/"
 _, df_val = download_mock_dataset(dataset_root)

docs/readme/examples_source/extractor/train_val_pl.md

@@ -7,16 +7,16 @@
 import pytorch_lightning as pl
 import torch
 
-from oml.datasets.base import DatasetQueryGallery, DatasetWithLabels
-from oml.lightning.modules.extractor import ExtractorModule
-from oml.lightning.callbacks.metric import MetricValCallback
-from oml.losses.triplet import TripletLossWithMiner
-from oml.metrics.embeddings import EmbeddingMetrics
-from oml.miners.inbatch_all_tri import AllTripletsMiner
+from oml.datasets import DatasetQueryGallery, DatasetWithLabels
+from oml.lightning import ExtractorModule
+from oml.lightning import MetricValCallback
+from oml.losses import TripletLossWithMiner
+from oml.metrics import EmbeddingMetrics
+from oml.miners import AllTripletsMiner
 from oml.models import ViTExtractor
-from oml.samplers.balance import BalanceSampler
-from oml.utils.download_mock_dataset import download_mock_dataset
-from oml.lightning.pipelines.logging import (
+from oml.samplers import BalanceSampler
+from oml.utils import download_mock_dataset
+from oml.lightning import (
     ClearMLPipelineLogger,
     MLFlowPipelineLogger,
     NeptunePipelineLogger,

docs/readme/examples_source/extractor/train_val_pl_ddp.md

@@ -8,15 +8,15 @@
 import pytorch_lightning as pl
 import torch
 
-from oml.datasets.base import DatasetQueryGallery, DatasetWithLabels
-from oml.lightning.modules.extractor import ExtractorModuleDDP
-from oml.lightning.callbacks.metric import MetricValCallbackDDP
-from oml.losses.triplet import TripletLossWithMiner
-from oml.metrics.embeddings import EmbeddingMetricsDDP
-from oml.miners.inbatch_all_tri import AllTripletsMiner
+from oml.datasets import DatasetQueryGallery, DatasetWithLabels
+from oml.lightning import ExtractorModuleDDP
+from oml.lightning import MetricValCallbackDDP
+from oml.losses import TripletLossWithMiner
+from oml.metrics import EmbeddingMetricsDDP
+from oml.miners import AllTripletsMiner
 from oml.models import ViTExtractor
-from oml.samplers.balance import BalanceSampler
-from oml.utils.download_mock_dataset import download_mock_dataset
+from oml.samplers import BalanceSampler
+from oml.utils import download_mock_dataset
 from pytorch_lightning.strategies import DDPStrategy
 
 dataset_root = "mock_dataset/"

docs/readme/examples_source/extractor/train_with_pml.md

@@ -6,10 +6,10 @@
 import torch
 from tqdm import tqdm
 
-from oml.datasets.base import DatasetWithLabels
+from oml.datasets import DatasetWithLabels
 from oml.models import ViTExtractor
-from oml.samplers.balance import BalanceSampler
-from oml.utils.download_mock_dataset import download_mock_dataset
+from oml.samplers import BalanceSampler
+from oml.utils import download_mock_dataset
 
 from pytorch_metric_learning import losses, distances, reducers, miners
 

docs/readme/examples_source/extractor/train_with_pml_advanced.md

@@ -6,10 +6,10 @@
 import torch
 from tqdm import tqdm
 
-from oml.datasets.base import DatasetWithLabels
+from oml.datasets import DatasetWithLabels
 from oml.models import ViTExtractor
-from oml.samplers.balance import BalanceSampler
-from oml.utils.download_mock_dataset import download_mock_dataset
+from oml.samplers import BalanceSampler
+from oml.utils import download_mock_dataset
 
 from pytorch_metric_learning import losses, distances, reducers, miners
 

docs/readme/examples_source/extractor/val.md

@@ -7,10 +7,10 @@
 import torch
 from tqdm import tqdm
 
-from oml.datasets.base import DatasetQueryGallery
-from oml.metrics.embeddings import EmbeddingMetrics
+from oml.datasets import DatasetQueryGallery
+from oml.metrics import EmbeddingMetrics
 from oml.models import ViTExtractor
-from oml.utils.download_mock_dataset import download_mock_dataset
+from oml.utils import download_mock_dataset
 
 dataset_root = "mock_dataset/"
 _, df_val = download_mock_dataset(dataset_root)

docs/readme/examples_source/extractor/val_with_sequence.md

@@ -37,10 +37,10 @@ To use this functionality you only need to provide `sequence` column in your dat
 import torch
 from tqdm import tqdm
 
-from oml.datasets.base import DatasetQueryGallery
-from oml.metrics.embeddings import EmbeddingMetrics
+from oml.datasets import DatasetQueryGallery
+from oml.metrics import EmbeddingMetrics
 from oml.models import ViTExtractor
-from oml.utils.download_mock_dataset import download_mock_dataset
+from oml.utils import download_mock_dataset
 
 dataset_root = "mock_dataset/"
 _, df_val = download_mock_dataset(dataset_root, df_name="df_with_sequence.csv")  # <- sequence info is in the file