pandas_profiling.config.Settings

pydantic settings pandas_profiling.config.Settings[source]

Show JSON schema
{
   "title": "Settings",
   "description": "Base class for settings, allowing values to be overridden by environment variables.\n\nThis is useful in production for secrets you do not wish to save in code, it plays nicely with docker(-compose),\nHeroku and any 12 factor app design.",
   "type": "object",
   "properties": {
      "title": {
         "title": "Title",
         "default": "Pandas Profiling Report",
         "env_names": [
            "title"
         ],
         "type": "string"
      },
      "dataset": {
         "title": "Dataset",
         "default": {
            "description": "",
            "creator": "",
            "author": "",
            "copyright_holder": "",
            "copyright_year": "",
            "url": ""
         },
         "env_names": [
            "dataset"
         ],
         "allOf": [
            {
               "$ref": "#/definitions/Dataset"
            }
         ]
      },
      "variables": {
         "title": "Variables",
         "default": {
            "descriptions": {}
         },
         "env_names": [
            "variables"
         ],
         "allOf": [
            {
               "$ref": "#/definitions/Variables"
            }
         ]
      },
      "infer_dtypes": {
         "title": "Infer Dtypes",
         "default": true,
         "env_names": [
            "infer_dtypes"
         ],
         "type": "boolean"
      },
      "show_variable_description": {
         "title": "Show Variable Description",
         "default": true,
         "env_names": [
            "show_variable_description"
         ],
         "type": "boolean"
      },
      "pool_size": {
         "title": "Pool Size",
         "default": 0,
         "env_names": [
            "pool_size"
         ],
         "type": "integer"
      },
      "progress_bar": {
         "title": "Progress Bar",
         "default": true,
         "env_names": [
            "progress_bar"
         ],
         "type": "boolean"
      },
      "vars": {
         "title": "Vars",
         "default": {
            "num": {
               "quantiles": [
                  0.05,
                  0.25,
                  0.5,
                  0.75,
                  0.95
               ],
               "skewness_threshold": 20,
               "low_categorical_threshold": 5,
               "chi_squared_threshold": 0.999
            },
            "cat": {
               "length": true,
               "characters": true,
               "words": true,
               "cardinality_threshold": 50,
               "n_obs": 5,
               "chi_squared_threshold": 0.999,
               "coerce_str_to_date": false,
               "redact": false,
               "histogram_largest": 50
            },
            "image": {
               "active": false,
               "exif": true,
               "hash": true
            },
            "bool": {
               "n_obs": 3,
               "mappings": {
                  "t": true,
                  "f": false,
                  "yes": true,
                  "no": false,
                  "y": true,
                  "n": false,
                  "true": true,
                  "false": false
               }
            },
            "path": {
               "active": false
            },
            "file": {
               "active": false
            },
            "url": {
               "active": false
            }
         },
         "env_names": [
            "vars"
         ],
         "allOf": [
            {
               "$ref": "#/definitions/Univariate"
            }
         ]
      },
      "sort": {
         "title": "Sort",
         "env_names": [
            "sort"
         ],
         "type": "string"
      },
      "missing_diagrams": {
         "title": "Missing Diagrams",
         "default": {
            "bar": true,
            "matrix": true,
            "dendrogram": true,
            "heatmap": true
         },
         "env_names": [
            "missing_diagrams"
         ],
         "type": "object",
         "additionalProperties": {
            "type": "boolean"
         }
      },
      "correlations": {
         "title": "Correlations",
         "default": {
            "spearman": {
               "key": "spearman",
               "calculate": true,
               "warn_high_correlations": 10,
               "threshold": 0.5
            },
            "pearson": {
               "key": "pearson",
               "calculate": true,
               "warn_high_correlations": 10,
               "threshold": 0.5
            },
            "kendall": {
               "key": "kendall",
               "calculate": true,
               "warn_high_correlations": 10,
               "threshold": 0.5
            },
            "cramers": {
               "key": "cramers",
               "calculate": true,
               "warn_high_correlations": 10,
               "threshold": 0.5
            },
            "phi_k": {
               "key": "phi_k",
               "calculate": true,
               "warn_high_correlations": 10,
               "threshold": 0.5
            }
         },
         "env_names": [
            "correlations"
         ],
         "type": "object",
         "additionalProperties": {
            "$ref": "#/definitions/Correlation"
         }
      },
      "interactions": {
         "title": "Interactions",
         "default": {
            "continuous": true,
            "targets": []
         },
         "env_names": [
            "interactions"
         ],
         "allOf": [
            {
               "$ref": "#/definitions/Interactions"
            }
         ]
      },
      "categorical_maximum_correlation_distinct": {
         "title": "Categorical Maximum Correlation Distinct",
         "default": 100,
         "env_names": [
            "categorical_maximum_correlation_distinct"
         ],
         "type": "integer"
      },
      "memory_deep": {
         "title": "Memory Deep",
         "default": false,
         "env_names": [
            "memory_deep"
         ],
         "type": "boolean"
      },
      "plot": {
         "title": "Plot",
         "default": {
            "missing": {
               "force_labels": true,
               "cmap": "RdBu"
            },
            "image_format": "svg",
            "correlation": {
               "cmap": "RdBu",
               "bad": "#000000"
            },
            "dpi": 800,
            "histogram": {
               "bins": 50,
               "max_bins": 250,
               "x_axis_labels": true
            },
            "scatter_threshold": 1000,
            "pie": {
               "max_unique": 10
            }
         },
         "env_names": [
            "plot"
         ],
         "allOf": [
            {
               "$ref": "#/definitions/Plot"
            }
         ]
      },
      "duplicates": {
         "title": "Duplicates",
         "default": {
            "head": 10,
            "key": "# duplicates"
         },
         "env_names": [
            "duplicates"
         ],
         "allOf": [
            {
               "$ref": "#/definitions/Duplicates"
            }
         ]
      },
      "samples": {
         "title": "Samples",
         "default": {
            "head": 10,
            "tail": 10,
            "random": 0
         },
         "env_names": [
            "samples"
         ],
         "allOf": [
            {
               "$ref": "#/definitions/Samples"
            }
         ]
      },
      "reject_variables": {
         "title": "Reject Variables",
         "default": true,
         "env_names": [
            "reject_variables"
         ],
         "type": "boolean"
      },
      "n_obs_unique": {
         "title": "N Obs Unique",
         "default": 10,
         "env_names": [
            "n_obs_unique"
         ],
         "type": "integer"
      },
      "n_freq_table_max": {
         "title": "N Freq Table Max",
         "default": 10,
         "env_names": [
            "n_freq_table_max"
         ],
         "type": "integer"
      },
      "n_extreme_obs": {
         "title": "N Extreme Obs",
         "default": 10,
         "env_names": [
            "n_extreme_obs"
         ],
         "type": "integer"
      },
      "report": {
         "title": "Report",
         "default": {
            "precision": 10
         },
         "env_names": [
            "report"
         ],
         "allOf": [
            {
               "$ref": "#/definitions/Report"
            }
         ]
      },
      "html": {
         "title": "Html",
         "default": {
            "style": {
               "primary_color": "#337ab7",
               "logo": "",
               "theme": null
            },
            "navbar_show": true,
            "minify_html": true,
            "use_local_assets": true,
            "inline": true,
            "assets_prefix": null,
            "assets_path": null,
            "full_width": false
         },
         "env_names": [
            "html"
         ],
         "allOf": [
            {
               "$ref": "#/definitions/Html"
            }
         ]
      },
      "notebook": {
         "title": "Notebook",
         "default": {
            "iframe": {
               "height": "800px",
               "width": "100%",
               "attribute": "srcdoc"
            }
         },
         "env_names": [
            "notebook"
         ],
         "allOf": [
            {
               "$ref": "#/definitions/Notebook"
            }
         ]
      }
   },
   "additionalProperties": false,
   "definitions": {
      "Dataset": {
         "title": "Dataset",
         "description": "Metadata of the dataset",
         "type": "object",
         "properties": {
            "description": {
               "title": "Description",
               "default": "",
               "type": "string"
            },
            "creator": {
               "title": "Creator",
               "default": "",
               "type": "string"
            },
            "author": {
               "title": "Author",
               "default": "",
               "type": "string"
            },
            "copyright_holder": {
               "title": "Copyright Holder",
               "default": "",
               "type": "string"
            },
            "copyright_year": {
               "title": "Copyright Year",
               "default": "",
               "type": "string"
            },
            "url": {
               "title": "Url",
               "default": "",
               "type": "string"
            }
         }
      },
      "Variables": {
         "title": "Variables",
         "type": "object",
         "properties": {
            "descriptions": {
               "title": "Descriptions",
               "default": {},
               "type": "object"
            }
         }
      },
      "NumVars": {
         "title": "NumVars",
         "type": "object",
         "properties": {
            "quantiles": {
               "title": "Quantiles",
               "default": [
                  0.05,
                  0.25,
                  0.5,
                  0.75,
                  0.95
               ],
               "type": "array",
               "items": {
                  "type": "number"
               }
            },
            "skewness_threshold": {
               "title": "Skewness Threshold",
               "default": 20,
               "type": "integer"
            },
            "low_categorical_threshold": {
               "title": "Low Categorical Threshold",
               "default": 5,
               "type": "integer"
            },
            "chi_squared_threshold": {
               "title": "Chi Squared Threshold",
               "default": 0.999,
               "type": "number"
            }
         }
      },
      "CatVars": {
         "title": "CatVars",
         "type": "object",
         "properties": {
            "length": {
               "title": "Length",
               "default": true,
               "type": "boolean"
            },
            "characters": {
               "title": "Characters",
               "default": true,
               "type": "boolean"
            },
            "words": {
               "title": "Words",
               "default": true,
               "type": "boolean"
            },
            "cardinality_threshold": {
               "title": "Cardinality Threshold",
               "default": 50,
               "type": "integer"
            },
            "n_obs": {
               "title": "N Obs",
               "default": 5,
               "type": "integer"
            },
            "chi_squared_threshold": {
               "title": "Chi Squared Threshold",
               "default": 0.999,
               "type": "number"
            },
            "coerce_str_to_date": {
               "title": "Coerce Str To Date",
               "default": false,
               "type": "boolean"
            },
            "redact": {
               "title": "Redact",
               "default": false,
               "type": "boolean"
            },
            "histogram_largest": {
               "title": "Histogram Largest",
               "default": 50,
               "type": "integer"
            }
         }
      },
      "ImageVars": {
         "title": "ImageVars",
         "type": "object",
         "properties": {
            "active": {
               "title": "Active",
               "default": false,
               "type": "boolean"
            },
            "exif": {
               "title": "Exif",
               "default": true,
               "type": "boolean"
            },
            "hash": {
               "title": "Hash",
               "default": true,
               "type": "boolean"
            }
         }
      },
      "BoolVars": {
         "title": "BoolVars",
         "type": "object",
         "properties": {
            "n_obs": {
               "title": "N Obs",
               "default": 3,
               "type": "integer"
            },
            "mappings": {
               "title": "Mappings",
               "default": {
                  "t": true,
                  "f": false,
                  "yes": true,
                  "no": false,
                  "y": true,
                  "n": false,
                  "true": true,
                  "false": false
               },
               "type": "object",
               "additionalProperties": {
                  "type": "boolean"
               }
            }
         }
      },
      "PathVars": {
         "title": "PathVars",
         "type": "object",
         "properties": {
            "active": {
               "title": "Active",
               "default": false,
               "type": "boolean"
            }
         }
      },
      "FileVars": {
         "title": "FileVars",
         "type": "object",
         "properties": {
            "active": {
               "title": "Active",
               "default": false,
               "type": "boolean"
            }
         }
      },
      "UrlVars": {
         "title": "UrlVars",
         "type": "object",
         "properties": {
            "active": {
               "title": "Active",
               "default": false,
               "type": "boolean"
            }
         }
      },
      "Univariate": {
         "title": "Univariate",
         "type": "object",
         "properties": {
            "num": {
               "title": "Num",
               "default": {
                  "quantiles": [
                     0.05,
                     0.25,
                     0.5,
                     0.75,
                     0.95
                  ],
                  "skewness_threshold": 20,
                  "low_categorical_threshold": 5,
                  "chi_squared_threshold": 0.999
               },
               "allOf": [
                  {
                     "$ref": "#/definitions/NumVars"
                  }
               ]
            },
            "cat": {
               "title": "Cat",
               "default": {
                  "length": true,
                  "characters": true,
                  "words": true,
                  "cardinality_threshold": 50,
                  "n_obs": 5,
                  "chi_squared_threshold": 0.999,
                  "coerce_str_to_date": false,
                  "redact": false,
                  "histogram_largest": 50
               },
               "allOf": [
                  {
                     "$ref": "#/definitions/CatVars"
                  }
               ]
            },
            "image": {
               "title": "Image",
               "default": {
                  "active": false,
                  "exif": true,
                  "hash": true
               },
               "allOf": [
                  {
                     "$ref": "#/definitions/ImageVars"
                  }
               ]
            },
            "bool": {
               "title": "Bool",
               "default": {
                  "n_obs": 3,
                  "mappings": {
                     "t": true,
                     "f": false,
                     "yes": true,
                     "no": false,
                     "y": true,
                     "n": false,
                     "true": true,
                     "false": false
                  }
               },
               "allOf": [
                  {
                     "$ref": "#/definitions/BoolVars"
                  }
               ]
            },
            "path": {
               "title": "Path",
               "default": {
                  "active": false
               },
               "allOf": [
                  {
                     "$ref": "#/definitions/PathVars"
                  }
               ]
            },
            "file": {
               "title": "File",
               "default": {
                  "active": false
               },
               "allOf": [
                  {
                     "$ref": "#/definitions/FileVars"
                  }
               ]
            },
            "url": {
               "title": "Url",
               "default": {
                  "active": false
               },
               "allOf": [
                  {
                     "$ref": "#/definitions/UrlVars"
                  }
               ]
            }
         }
      },
      "Correlation": {
         "title": "Correlation",
         "type": "object",
         "properties": {
            "key": {
               "title": "Key",
               "default": "",
               "type": "string"
            },
            "calculate": {
               "title": "Calculate",
               "default": true,
               "type": "boolean"
            },
            "warn_high_correlations": {
               "title": "Warn High Correlations",
               "default": 10,
               "type": "integer"
            },
            "threshold": {
               "title": "Threshold",
               "default": 0.5,
               "type": "number"
            }
         }
      },
      "Interactions": {
         "title": "Interactions",
         "type": "object",
         "properties": {
            "continuous": {
               "title": "Continuous",
               "default": true,
               "type": "boolean"
            },
            "targets": {
               "title": "Targets",
               "default": [],
               "type": "array",
               "items": {
                  "type": "string"
               }
            }
         }
      },
      "MissingPlot": {
         "title": "MissingPlot",
         "type": "object",
         "properties": {
            "force_labels": {
               "title": "Force Labels",
               "default": true,
               "type": "boolean"
            },
            "cmap": {
               "title": "Cmap",
               "default": "RdBu",
               "type": "string"
            }
         }
      },
      "ImageType": {
         "title": "ImageType",
         "description": "An enumeration.",
         "enum": [
            "svg",
            "png"
         ]
      },
      "CorrelationPlot": {
         "title": "CorrelationPlot",
         "type": "object",
         "properties": {
            "cmap": {
               "title": "Cmap",
               "default": "RdBu",
               "type": "string"
            },
            "bad": {
               "title": "Bad",
               "default": "#000000",
               "type": "string"
            }
         }
      },
      "Histogram": {
         "title": "Histogram",
         "type": "object",
         "properties": {
            "bins": {
               "title": "Bins",
               "default": 50,
               "type": "integer"
            },
            "max_bins": {
               "title": "Max Bins",
               "default": 250,
               "type": "integer"
            },
            "x_axis_labels": {
               "title": "X Axis Labels",
               "default": true,
               "type": "boolean"
            }
         }
      },
      "Pie": {
         "title": "Pie",
         "type": "object",
         "properties": {
            "max_unique": {
               "title": "Max Unique",
               "default": 10,
               "type": "integer"
            }
         }
      },
      "Plot": {
         "title": "Plot",
         "type": "object",
         "properties": {
            "missing": {
               "title": "Missing",
               "default": {
                  "force_labels": true,
                  "cmap": "RdBu"
               },
               "allOf": [
                  {
                     "$ref": "#/definitions/MissingPlot"
                  }
               ]
            },
            "image_format": {
               "default": "svg",
               "allOf": [
                  {
                     "$ref": "#/definitions/ImageType"
                  }
               ]
            },
            "correlation": {
               "title": "Correlation",
               "default": {
                  "cmap": "RdBu",
                  "bad": "#000000"
               },
               "allOf": [
                  {
                     "$ref": "#/definitions/CorrelationPlot"
                  }
               ]
            },
            "dpi": {
               "title": "Dpi",
               "default": 800,
               "type": "integer"
            },
            "histogram": {
               "title": "Histogram",
               "default": {
                  "bins": 50,
                  "max_bins": 250,
                  "x_axis_labels": true
               },
               "allOf": [
                  {
                     "$ref": "#/definitions/Histogram"
                  }
               ]
            },
            "scatter_threshold": {
               "title": "Scatter Threshold",
               "default": 1000,
               "type": "integer"
            },
            "pie": {
               "title": "Pie",
               "default": {
                  "max_unique": 10
               },
               "allOf": [
                  {
                     "$ref": "#/definitions/Pie"
                  }
               ]
            }
         }
      },
      "Duplicates": {
         "title": "Duplicates",
         "type": "object",
         "properties": {
            "head": {
               "title": "Head",
               "default": 10,
               "type": "integer"
            },
            "key": {
               "title": "Key",
               "default": "# duplicates",
               "type": "string"
            }
         }
      },
      "Samples": {
         "title": "Samples",
         "type": "object",
         "properties": {
            "head": {
               "title": "Head",
               "default": 10,
               "type": "integer"
            },
            "tail": {
               "title": "Tail",
               "default": 10,
               "type": "integer"
            },
            "random": {
               "title": "Random",
               "default": 0,
               "type": "integer"
            }
         }
      },
      "Report": {
         "title": "Report",
         "type": "object",
         "properties": {
            "precision": {
               "title": "Precision",
               "default": 10,
               "type": "integer"
            }
         }
      },
      "Theme": {
         "title": "Theme",
         "description": "An enumeration.",
         "enum": [
            "united",
            "flatly"
         ]
      },
      "Style": {
         "title": "Style",
         "type": "object",
         "properties": {
            "primary_color": {
               "title": "Primary Color",
               "default": "#337ab7",
               "type": "string"
            },
            "logo": {
               "title": "Logo",
               "default": "",
               "type": "string"
            },
            "theme": {
               "$ref": "#/definitions/Theme"
            }
         }
      },
      "Html": {
         "title": "Html",
         "type": "object",
         "properties": {
            "style": {
               "title": "Style",
               "default": {
                  "primary_color": "#337ab7",
                  "logo": "",
                  "theme": null
               },
               "allOf": [
                  {
                     "$ref": "#/definitions/Style"
                  }
               ]
            },
            "navbar_show": {
               "title": "Navbar Show",
               "default": true,
               "type": "boolean"
            },
            "minify_html": {
               "title": "Minify Html",
               "default": true,
               "type": "boolean"
            },
            "use_local_assets": {
               "title": "Use Local Assets",
               "default": true,
               "type": "boolean"
            },
            "inline": {
               "title": "Inline",
               "default": true,
               "type": "boolean"
            },
            "assets_prefix": {
               "title": "Assets Prefix",
               "type": "string"
            },
            "assets_path": {
               "title": "Assets Path",
               "type": "string"
            },
            "full_width": {
               "title": "Full Width",
               "default": false,
               "type": "boolean"
            }
         }
      },
      "IframeAttribute": {
         "title": "IframeAttribute",
         "description": "An enumeration.",
         "enum": [
            "src",
            "srcdoc"
         ]
      },
      "Iframe": {
         "title": "Iframe",
         "type": "object",
         "properties": {
            "height": {
               "title": "Height",
               "default": "800px",
               "type": "string"
            },
            "width": {
               "title": "Width",
               "default": "100%",
               "type": "string"
            },
            "attribute": {
               "default": "srcdoc",
               "allOf": [
                  {
                     "$ref": "#/definitions/IframeAttribute"
                  }
               ]
            }
         }
      },
      "Notebook": {
         "title": "Notebook",
         "description": "When in a Jupyter notebook",
         "type": "object",
         "properties": {
            "iframe": {
               "title": "Iframe",
               "default": {
                  "height": "800px",
                  "width": "100%",
                  "attribute": "srcdoc"
               },
               "allOf": [
                  {
                     "$ref": "#/definitions/Iframe"
                  }
               ]
            }
         }
      }
   }
}

Fields
field categorical_maximum_correlation_distinct: int = 100
field correlations: Dict[str, pandas_profiling.config.Correlation] = {'cramers': Correlation(key='cramers', calculate=True, warn_high_correlations=10, threshold=0.5), 'kendall': Correlation(key='kendall', calculate=True, warn_high_correlations=10, threshold=0.5), 'pearson': Correlation(key='pearson', calculate=True, warn_high_correlations=10, threshold=0.5), 'phi_k': Correlation(key='phi_k', calculate=True, warn_high_correlations=10, threshold=0.5), 'spearman': Correlation(key='spearman', calculate=True, warn_high_correlations=10, threshold=0.5)}
field dataset: pandas_profiling.config.Dataset = Dataset(description='', creator='', author='', copyright_holder='', copyright_year='', url='')
field duplicates: pandas_profiling.config.Duplicates = Duplicates(head=10, key='# duplicates')
field html: pandas_profiling.config.Html = Html(style=Style(primary_color='#337ab7', logo='', theme=None), navbar_show=True, minify_html=True, use_local_assets=True, inline=True, assets_prefix=None, assets_path=None, full_width=False)
field infer_dtypes: bool = True
field interactions: pandas_profiling.config.Interactions = Interactions(continuous=True, targets=[])
field memory_deep: bool = False
field missing_diagrams: Dict[str, bool] = {'bar': True, 'dendrogram': True, 'heatmap': True, 'matrix': True}
field n_extreme_obs: int = 10
field n_freq_table_max: int = 10
field n_obs_unique: int = 10
field plot: pandas_profiling.config.Plot = Plot(missing=MissingPlot(force_labels=True, cmap='RdBu'), image_format=<ImageType.svg: 'svg'>, correlation=CorrelationPlot(cmap='RdBu', bad='#000000'), dpi=800, histogram=Histogram(bins=50, max_bins=250, x_axis_labels=True), scatter_threshold=1000, pie=Pie(max_unique=10))
field pool_size: int = 0
field progress_bar: bool = True
field reject_variables: bool = True
field report: pandas_profiling.config.Report = Report(precision=10)
field samples: pandas_profiling.config.Samples = Samples(head=10, tail=10, random=0)
field show_variable_description: bool = True
field sort: Optional[str]
field title: str = 'Pandas Profiling Report'
field variables: pandas_profiling.config.Variables = Variables(descriptions={})
field vars: pandas_profiling.config.Univariate = Univariate(num=NumVars(quantiles=[0.05, 0.25, 0.5, 0.75, 0.95], skewness_threshold=20, low_categorical_threshold=5, chi_squared_threshold=0.999), cat=CatVars(length=True, characters=True, words=True, cardinality_threshold=50, n_obs=5, chi_squared_threshold=0.999, coerce_str_to_date=False, redact=False, histogram_largest=50), image=ImageVars(active=False, exif=True, hash=True), bool=BoolVars(n_obs=3, mappings={'t': True, 'f': False, 'yes': True, 'no': False, 'y': True, 'n': False, 'true': True, 'false': False}), path=PathVars(active=False), file=FileVars(active=False), url=UrlVars(active=False))
update(updates)[source]
Return type

Settings