Welcome to py4ai-data documentation!

Intro:

• py4ai data
  • What is it ?
  • Features
    • Data layers
    • Data Model
  • Installation
  • Tests
  • Checks
  • Examples
    • Data Layers
      • Abstracting Data Querying
    • Data Model
  • How to contribute ?
    • Where to start ?
    • Contributing to py4ai-data

User Guide

• Installation
  • Package Requirements
  • CI Requirements
  • Installation

Developer Guide:

• py4ai
  • py4ai namespace
    • Subpackages
      • py4ai.data package
        • Subpackages
          • py4ai.data.datasets package
            • get_unbalanced_dataset()
            • get_weather_nyc_dataset()
          • py4ai.data.layer package
            • Subpackages
              • py4ai.data.layer.common package
                • Submodules
                  • py4ai.data.layer.common.criteria module
                    • BaseCriteria
                      • BaseCriteria.query
                    • SearchCriteria
                  • py4ai.data.layer.common.repository module
                    • Paged
                      • Paged.items
                      • Paged.more_pages
                      • Paged.size
                    • QueryOptions
                      • QueryOptions.copy()
                    • Repository
                      • Repository.create()
                      • Repository.delete()
                      • Repository.delete_by_criteria()
                      • Repository.list()
                      • Repository.retrieve()
                      • Repository.retrieve_by_criteria()
                      • Repository.save()
                      • Repository.serializer
                    • SortingDirection
                      • SortingDirection.ASC
                      • SortingDirection.DES
                  • py4ai.data.layer.common.serialiazer module
                    • DataSerializer
                      • DataSerializer.get_key()
                      • DataSerializer.to_entity()
                      • DataSerializer.to_object()
                      • DataSerializer.to_object_key()
              • py4ai.data.layer.fs package
                • complete_path_split()
                • create_dir_if_not_exists()
                • Submodules
                  • py4ai.data.layer.fs.criteria module
                    • FileSystemCriteriaFactory
                      • FileSystemCriteriaFactory.all()
                      • FileSystemCriteriaFactory.filter_path_by_condition()
                      • FileSystemCriteriaFactory.format_name()
                      • FileSystemCriteriaFactory.get_index_fields()
                      • FileSystemCriteriaFactory.index
                      • FileSystemCriteriaFactory.sort_by()
                      • FileSystemCriteriaFactory.update_index()
                    • FileSystemSearchCriteria
                      • FileSystemSearchCriteria.query
                  • py4ai.data.layer.fs.repository module
                    • FileSystemRepository
                      • FileSystemRepository.create()
                      • FileSystemRepository.criteria
                      • FileSystemRepository.delete()
                      • FileSystemRepository.delete_by_criteria()
                      • FileSystemRepository.list()
                      • FileSystemRepository.retrieve()
                      • FileSystemRepository.retrieve_by_criteria()
                      • FileSystemRepository.save()
                      • FileSystemRepository.serializer
                  • py4ai.data.layer.fs.serializer module
                    • FileSerializer
                      • FileSerializer.mode
                      • FileSerializer.with_path()
                    • FileSerializerMode
                      • FileSerializerMode.BINARY
                      • FileSerializerMode.TEXT
                    • IndexedIO
                      • IndexedIO.Config
                        • IndexedIO.Config.arbitrary_types_allowed
                      • IndexedIO.buffer
                      • IndexedIO.name
                  • py4ai.data.layer.fs.tables module
                    • CsvSerializer
                      • CsvSerializer.get_key()
                      • CsvSerializer.mode
                      • CsvSerializer.to_entity()
                      • CsvSerializer.to_object()
                      • CsvSerializer.to_object_key()
                    • LocalDatabase
                      • LocalDatabase.criteria
                    • PickleSerializer
                      • PickleSerializer.mode
                      • PickleSerializer.to_entity()
                      • PickleSerializer.to_object()
                      • PickleSerializer.to_object_key()
                    • TabularData
                      • TabularData.Config
                        • TabularData.Config.arbitrary_types_allowed
                      • TabularData.data
                      • TabularData.name
                      • TabularData.update()
              • py4ai.data.layer.mongo package
                • MongoConfig
                  • MongoConfig.admin
                  • MongoConfig.auth
                  • MongoConfig.authSource
                  • MongoConfig.db_name
                  • MongoConfig.getCollection()
                  • MongoConfig.host
                  • MongoConfig.port
                • Submodules
                  • py4ai.data.layer.mongo.criteria module
                    • MongoSearchCriteria
                      • MongoSearchCriteria.empty()
                      • MongoSearchCriteria.query
                  • py4ai.data.layer.mongo.repository module
                    • MongoRepository
                      • MongoRepository.create()
                      • MongoRepository.delete()
                      • MongoRepository.delete_by_criteria()
                      • MongoRepository.list()
                      • MongoRepository.retrieve()
                      • MongoRepository.retrieve_by_criteria()
                      • MongoRepository.save()
                      • MongoRepository.serializer
                  • py4ai.data.layer.mongo.serializer module
                    • MongoModel
                    • create_mongo_id()
              • py4ai.data.layer.pandas package
                • Submodules
                  • py4ai.data.layer.pandas.criteria module
                    • PandasSearchCriteria
                      • PandasSearchCriteria.empty()
                      • PandasSearchCriteria.query
                  • py4ai.data.layer.pandas.repository module
                    • CsvRepository
                    • PandasRepository
                      • PandasRepository.commit()
                      • PandasRepository.create()
                      • PandasRepository.data
                      • PandasRepository.delete()
                      • PandasRepository.delete_by_criteria()
                      • PandasRepository.list()
                      • PandasRepository.retrieve()
                      • PandasRepository.retrieve_by_criteria()
                      • PandasRepository.save()
                      • PandasRepository.serializer
              • py4ai.data.layer.sqlalchemy package
                • Submodules
                  • py4ai.data.layer.sqlalchemy.criteria module
                    • SqlAlchemySearchCriteria
                      • SqlAlchemySearchCriteria.empty()
                      • SqlAlchemySearchCriteria.query
                  • py4ai.data.layer.sqlalchemy.repository module
                    • SqlAlchemyRepository
                      • SqlAlchemyRepository.create()
                      • SqlAlchemyRepository.delete()
                      • SqlAlchemyRepository.delete_by_criteria()
                      • SqlAlchemyRepository.list()
                      • SqlAlchemyRepository.retrieve()
                      • SqlAlchemyRepository.retrieve_by_criteria()
                      • SqlAlchemyRepository.save()
                      • SqlAlchemyRepository.serializer
                  • py4ai.data.layer.sqlalchemy.serializer module
                    • SqlAlchemySerializer
          • py4ai.data.model package
            • Submodules
              • py4ai.data.model.core module
                • BaseIterable
                  • BaseIterable.cached
                  • BaseIterable.empty()
                  • BaseIterable.items
                  • BaseIterable.type
                • BaseRange
                  • BaseRange.business_days
                  • BaseRange.days
                  • BaseRange.end
                  • BaseRange.minutes_15
                  • BaseRange.overlaps()
                  • BaseRange.range()
                  • BaseRange.start
                • CachedIterable
                  • CachedIterable.cached
                  • CachedIterable.empty()
                  • CachedIterable.from_iterable()
                  • CachedIterable.items
                • CompositeRange
                  • CompositeRange.end
                  • CompositeRange.overlaps()
                  • CompositeRange.range()
                  • CompositeRange.simplify()
                  • CompositeRange.start
                • DillSerialization
                  • DillSerialization.load()
                  • DillSerialization.write()
                • IterGenerator
                  • IterGenerator.iterator
                • IterableUtilsMixin
                  • IterableUtilsMixin.batch()
                  • IterableUtilsMixin.cached_type
                  • IterableUtilsMixin.filter()
                  • IterableUtilsMixin.foreach()
                  • IterableUtilsMixin.from_element()
                  • IterableUtilsMixin.lazy_type
                  • IterableUtilsMixin.map()
                  • IterableUtilsMixin.take()
                  • IterableUtilsMixin.to_cached()
                  • IterableUtilsMixin.to_lazy()
                • LazyIterable
                  • LazyIterable.cached
                  • LazyIterable.empty()
                  • LazyIterable.from_iterable()
                  • LazyIterable.items
                • PickleSerialization
                  • PickleSerialization.load()
                  • PickleSerialization.write()
                • Range
                  • Range.end
                  • Range.overlaps()
                  • Range.range()
                  • Range.start
                • RegisterLazyCachedIterables
                  • RegisterLazyCachedIterables.register_cached()
                  • RegisterLazyCachedIterables.register_lazy()
                • Serializable
                  • Serializable.load()
                  • Serializable.write()
              • py4ai.data.model.ml module
                • CachedDataset
                  • CachedDataset.cached_type
                  • CachedDataset.lazy_type
                  • CachedDataset.to_df()
                  • CachedDataset.union()
                • DatasetUtilsMixin
                  • DatasetUtilsMixin.asPandasDataset
                  • DatasetUtilsMixin.cached_type
                  • DatasetUtilsMixin.checkNames()
                  • DatasetUtilsMixin.getFeaturesAs()
                  • DatasetUtilsMixin.getLabelsAs()
                  • DatasetUtilsMixin.lazy_type
                  • DatasetUtilsMixin.type
                  • DatasetUtilsMixin.union()
                • LazyDataset
                  • LazyDataset.cached_type
                  • LazyDataset.features()
                  • LazyDataset.getFeaturesAs()
                  • LazyDataset.getLabelsAs()
                  • LazyDataset.labels()
                  • LazyDataset.lazy_type
                  • LazyDataset.union()
                  • LazyDataset.withLookback()
                • MultiFeatureSample
                • PandasDataset
                  • PandasDataset.cached
                  • PandasDataset.cached_type
                  • PandasDataset.createObject()
                  • PandasDataset.dropna()
                  • PandasDataset.empty()
                  • PandasDataset.features
                  • PandasDataset.from_sequence()
                  • PandasDataset.getFeaturesAs()
                  • PandasDataset.getLabelsAs()
                  • PandasDataset.index
                  • PandasDataset.intersection()
                  • PandasDataset.items
                  • PandasDataset.labels
                  • PandasDataset.lazy_type
                  • PandasDataset.loc()
                  • PandasDataset.takeAsPandas()
                  • PandasDataset.union()
                • PandasTimeIndexedDataset
                • Sample
                • features_and_labels_to_dataset()
              • py4ai.data.model.text module
                • CachedDocuments
                  • CachedDocuments.cached_type
                  • CachedDocuments.lazy_type
                  • CachedDocuments.to_df()
                • Document
                  • Document.addProperty()
                  • Document.author
                  • Document.getOrThrow()
                  • Document.items()
                  • Document.language
                  • Document.properties
                  • Document.removeProperty()
                  • Document.setRandomUUID()
                  • Document.text
                • DocumentsUtilsMixin
                  • DocumentsUtilsMixin.cached_type
                  • DocumentsUtilsMixin.lazy_type
                  • DocumentsUtilsMixin.type
                • LazyDocuments
                  • LazyDocuments.cached_type
                  • LazyDocuments.lazy_type
                • generate_random_uuid()
        • Submodules
          • py4ai.data.exceptions module
            • NoTableException

Indices and tables

• Index

• Module Index

• Search Page