Skip to content

If you like the package, spread the word and give us a on GitHub!

You're not viewing the latest version. Click here to go to latest.

logo
Paguro
paguro.validation.vrelations
Initializing search
    bernardodionisi/paguro
    • Installation
    • Tutorials
    • API
    bernardodionisi/paguro
      • Getting Started
      • User Guide
      • Validation
        • p vcol
        • p vframe
        • p vrelations
          • Call
      • Dataset
        • C Dataset
          • Constructors
            • M __init__
          • Validation + Model
            • Validation
              • M with_validation
              • P validation
              • M validate
            • Model
              • P vcol
              • P model
              • M with_model
              • M without_model
              • M collect_model_blueprint
          • Information
            • M with_info
            • M with_name
          • EDA
            • M skim
          • Export
            • M to_polars
            • M to_dataframe
            • M to_lazyframe
          • Polars Methods
            • Adapted
              • M write_parquet
              • M lazy
              • M group_by
              • M group_by_dynamic
              • M rolling
              • M join
              • M join_asof
              • M join_where
              • M merge_sorted
              • M vstack
              • M rename
            • Delegated
              • M set_sorted
              • M approx_n_unique
              • M bottom_k
              • M cast
              • M clear
              • M clone
              • M collect_schema
              • P columns
              • M corr
              • M count
              • M describe
              • M drop
              • M drop_in_place
              • M drop_nans
              • M drop_nulls
              • P dtypes
              • M equals
              • M estimated_size
              • M explode
              • M extend
              • M fill_nan
              • M fill_null
              • M filter
              • P flags
              • M fold
              • M gather_every
              • M get_column
              • M get_column_index
              • M get_columns
              • M glimpse
              • M hash_rows
              • M head
              • P height
              • M hstack
              • M insert_column
              • M interpolate
              • M is_duplicated
              • M is_empty
              • M is_unique
              • M item
              • M iter_columns
              • M iter_rows
              • M iter_slices
              • M limit
              • M map_columns
              • M map_rows
              • M match_to_schema
              • M max
              • M max_horizontal
              • M mean
              • M mean_horizontal
              • M median
              • M melt
              • M min
              • M min_horizontal
              • M n_chunks
              • M n_unique
              • M null_count
              • M partition_by
              • M pipe
              • M pivot
              • P plot
              • M product
              • M quantile
              • M rechunk
              • M remove
              • M replace_column
              • M reverse
              • M row
              • M rows
              • M rows_by_key
              • M sample
              • P schema
              • M select
              • M select_seq
              • P shape
              • M shift
              • M shrink_to_fit
              • M slice
              • M sort
              • M sql
              • M std
              • P style
              • M sum
              • M sum_horizontal
              • M tail
              • M top_k
              • M transpose
              • M unique
              • M unnest
              • M unpivot
              • M unstack
              • M update
              • M upsample
              • M var
              • P width
              • M with_columns
              • M with_columns_seq
              • M with_row_count
              • M with_row_index
              • M write_avro
              • M write_clipboard
              • M write_csv
              • M write_database
              • M write_delta
              • M write_excel
              • M write_iceberg
              • M write_ipc
              • M write_ipc_stream
              • M write_json
              • M write_ndjson
              • M to_arrow
              • M to_dict
              • M to_dicts
              • M to_dummies
              • M to_init_repr
              • M to_jax
              • M to_numpy
              • M to_pandas
              • M to_series
              • M to_struct
              • M to_torch
        • C LazyDataset
          • Constructors
            • M __init__
          • Validation + Model
            • Validation
              • M with_validation
            • Model
              • M without_model
          • Export
            • M to_polars
          • Polars Methods
            • Adapted
              • M sink_parquet
              • M collect
              • M group_by
              • M group_by_dynamic
              • M rolling
              • M join
              • M join_asof
              • M join_where
              • M merge_sorted
              • M rename
            • Delegated
              • M set_sorted
              • M lazy
              • M approx_n_unique
              • M bottom_k
              • M cache
              • M cast
              • M clear
              • M clone
              • M collect_async
              • M collect_batches
              • M collect_schema
              • P columns
              • M count
              • M describe
              • M drop
              • M drop_nans
              • M drop_nulls
              • P dtypes
              • M explain
              • M explode
              • M fetch
              • M fill_nan
              • M fill_null
              • M filter
              • M first
              • M gather_every
              • M head
              • M inspect
              • M interpolate
              • M last
              • M limit
              • M map_batches
              • M match_to_schema
              • M max
              • M mean
              • M median
              • M melt
              • M min
              • M null_count
              • M pipe
              • M pipe_with_schema
              • M profile
              • M quantile
              • M remote
              • M remove
              • M reverse
              • P schema
              • M select
              • M select_seq
              • M shift
              • M show_graph
              • M sink_batches
              • M sink_csv
              • M sink_ipc
              • M sink_ndjson
              • M slice
              • M sort
              • M sql
              • M std
              • M sum
              • M tail
              • M top_k
              • M unique
              • M unnest
              • M unpivot
              • M update
              • M var
              • P width
              • M with_columns
              • M with_columns_seq
              • M with_context
              • M with_row_count
              • M with_row_index
          • Properties
            • P vcol
            • P model
          • Methods
            • M with_model
            • M with_info
            • M with_name
      • Collection
        • C Collection
          • Constructors
            • M __init__
          • Config
            • M set_scope
            • M set_scope_by_index
          • Delegated
            • M set_sorted
            • M approx_n_unique
            • M bottom_k
            • M cast
            • M clear
            • M clone
            • M collect_model_blueprint
            • M collect_schema
            • M corr
            • M count
            • M describe
            • M drop
            • M drop_in_place
            • M drop_nans
            • M drop_nulls
            • M equals
            • M estimated_size
            • M explode
            • M extend
            • M fill_nan
            • M fill_null
            • M filter
            • M fold
            • M gather_every
            • M get_column
            • M get_column_index
            • M get_columns
            • M glimpse
            • M hash_rows
            • M head
            • M hstack
            • M insert_column
            • M interpolate
            • M is_duplicated
            • M is_empty
            • M is_unique
            • M item
            • M iter_columns
            • M iter_rows
            • M iter_slices
            • M limit
            • M map_columns
            • M map_rows
            • M match_to_schema
            • M max
            • M max_horizontal
            • M mean
            • M mean_horizontal
            • M median
            • M melt
            • M merge_sorted
            • M min
            • M min_horizontal
            • M n_chunks
            • M n_unique
            • M null_count
            • M partition_by
            • M pipe
            • M pivot
            • M product
            • M quantile
            • M rechunk
            • M remove
            • M rename
            • M replace_column
            • M reverse
            • M row
            • M rows
            • M rows_by_key
            • M sample
            • M select
            • M select_seq
            • M shift
            • M shrink_to_fit
            • M skim
            • M slice
            • M sort
            • M sql
            • M std
            • M sum
            • M sum_horizontal
            • M tail
            • M top_k
            • M transpose
            • M unique
            • M unnest
            • M unpivot
            • M unstack
            • M update
            • M upsample
            • M var
            • M vstack
            • M with_columns
            • M with_columns_seq
            • M with_name
            • M with_row_count
            • M with_row_index
            • M without_model
            • M to_arrow
            • M to_dataframe
            • M to_dummies
            • M to_init_repr
            • M to_jax
            • M to_lazyframe
            • M to_numpy
            • M to_pandas
            • M to_polars
            • M to_series
            • M to_struct
            • M to_torch
          • Methods
            • M lazy
            • M items
            • M keys
            • M values
            • M concat
            • M group_by
            • M join
          • Properties
            • P columns
            • P dtypes
            • P flags
            • P height
            • P model
            • P plot
            • P schema
            • P shape
            • P style
            • P vcol
            • P width
          • Export
            • M to_dict
        • C LazyCollection
          • Constructors
            • M __init__
          • Delegated
            • M set_sorted
            • M collect
            • M approx_n_unique
            • M bottom_k
            • M cache
            • M cast
            • M clear
            • M clone
            • M collect_async
            • M collect_batches
            • M collect_model_blueprint
            • M collect_schema
            • M count
            • M describe
            • M drop
            • M drop_nans
            • M drop_nulls
            • M explain
            • M explode
            • M fetch
            • M fill_nan
            • M fill_null
            • M filter
            • M first
            • M gather_every
            • M head
            • M inspect
            • M interpolate
            • M last
            • M limit
            • M map_batches
            • M match_to_schema
            • M max
            • M mean
            • M median
            • M melt
            • M merge_sorted
            • M min
            • M null_count
            • M pipe
            • M pipe_with_schema
            • M profile
            • M quantile
            • M remote
            • M remove
            • M rename
            • M reverse
            • M select
            • M select_seq
            • M shift
            • M show_graph
            • M skim
            • M slice
            • M sort
            • M sql
            • M std
            • M sum
            • M tail
            • M top_k
            • M unique
            • M unnest
            • M unpivot
            • M update
            • M var
            • M with_columns
            • M with_columns_seq
            • M with_context
            • M with_name
            • M with_row_count
            • M with_row_index
            • M without_model
            • M to_dataframe
            • M to_lazyframe
            • M to_polars
          • Properties
            • P columns
            • P dtypes
            • P model
            • P schema
            • P vcol
            • P width
      • …
        • Validation
          • Base Models
            • C VFrameModel
          • Validators
            • C ValidColumn
              • Settings
                • M with_name
              • Validation
                • M validate
              • Methods
                • M gather_predicates
              • Information
                • M with_info
              • Export
                • M serialize
                • M to_schema
            • C ValidFrame
              • Settings
                • M with_name
                • M with_columns_policy
              • Information
                • M with_info
              • Transformations
                • M transform
              • Validation
                • M validate
              • Methods
                • M gather_predicates
            • C ValidRelations
              • Validation
                • M validate
          • Exceptions
            • ValidationError
        • Read/Scan
          • Read
            • F read_parquet
            • F read_ipc
            • F read_avro
            • F read_csv
            • F read_database_uri
            • F read_delta
            • F read_json
            • F read_excel
            • F read_ndjson
            • F read_ods
          • Scan
            • F scan_parquet
            • F scan_ipc
            • F scan_csv
            • F scan_delta
            • F scan_ndjson
            • F scan_iceberg
            • F scan_pyarrow_dataset
        • Utilities
          • C Config
            • Constructors
              • M __init__
            • Display
              • M set_dataset_ashi_repr
            • Representation
              • M set_width_chars
              • M set_styled
            • Validation
              • M set_auto_validation_mode
              • M set_auto_validation_limit
            • Settings
              • M load
              • M load_from_file
              • M restore_defaults
              • M save
              • M save_to_file
              • M state
            • Special methods
              • M __call__
          • F show_versions
        • Typing
          • V ValidationMode
          • V ValidatorOrExpr
          • V IntoValidators
          • V IntoValidation
          • V FieldsValidators
          • V IntoKeepColumns
          • V OnSuccess
          • V OnFailure
          • V OnFailureExtra
    • Call
    paguro.vrelations

    Constructor for a ValidRelations validator.

    Call¶

    Call
    paguro.vrelations(*validators: ValidFrame | Iterable[ValidFrame], relations: IntoRelations | None = None, **constraints: CustomConstraint) → ValidRelations

    Call self as a function.

    © Copyright 2025, Bernardo Dionisi.
    Created using Sphinx 8.2.3. and Sphinx-Immaterial