Skip to main content
Ctrl+K
scikit-plots homepage scikit-plots homepage
  • Introduction
  • User Guide
  • APIs Reference
  • Tutorials
  • Learn
  • Tags
    • Affiliated Packages
    • Code of Conduct
    • Community
    • Developer's Guide
    • Governance Process
    • Release History
    • Roadmap
    • About Us | Project
  • Social Media Platforms
  • PyPI
  • GitHub
  • Introduction
  • User Guide
  • APIs Reference
  • Tutorials
  • Learn
  • Tags
  • Affiliated Packages
  • Code of Conduct
  • Community
  • Developer's Guide
  • Governance Process
  • Release History
  • Roadmap
  • About Us | Project
  • Social Media Platforms
  • PyPI
  • GitHub

Section Navigation

  • scikitplot
    • __version__
    • __version_iso_8601__
    • online_help
    • config_context
    • get_config
    • set_config
    • show_config
    • show_versions
    • get_logger
    • logger
  • scikitplot.annoy
    • Index
    • Annoy
    • AnnoyIndex
    • Index
    • threads_info
    • CompressMode
    • IndexIOMixin
    • MetaMixin
    • NDArrayMixin
    • PickleMixin
    • PickleMode
    • PlottingMixin
    • VectorOpsMixin
  • scikitplot.api
    • plot_pca_2d_projection
    • plot_pca_component_variance
    • plot_feature_importances
    • plot_learning_curve
    • plot_elbow
    • plot_residuals_distribution
    • plot_classifier_eval
    • plot_confusion_matrix
    • plot_precision_recall
    • plot_roc
    • plot_calibration
    • plot_silhouette
    • validate_labels
    • cumulative_gain_curve
    • binary_ks_curve
    • validate_plotting_kwargs
  • scikitplot.cleanprompt
    • EncodedPrompt
    • Handle
    • Session
    • decode
    • encode
    • session
    • SessionStore
    • create_app
    • TIERS
    • CapabilityReport
    • CapabilityStatus
    • capabilities
    • probe
    • require
    • load_custom
    • with_custom
    • Detector
    • DetectorRegistry
    • LiteralDetector
    • RegexDetector
    • default_registry
    • BlindSpot
    • Diagnosis
    • Suggestion
    • describe_outcome
    • diagnose
    • suggest_terms
    • Redactor
    • reserved_label_spans
    • resolve_spans
    • restore
    • CANONICAL_LABELS
    • DEFAULT_ENGINE
    • ENGINES
    • ENGINE_MODES
    • EngineSpec
    • build_detectors
    • canonical_label
    • describe_engines
    • resolve_engine
    • trim_entity_span
    • FormatSpec
    • Guard
    • StreamDecoder
    • DEFAULT_LANGUAGE
    • LANGUAGES
    • MODEL_SIZES
    • MULTILINGUAL_MODEL
    • LanguageSpec
    • installed_models
    • resolve_model
    • supported_languages
    • McpServer
    • DEFAULT_ENTITY_LABELS
    • DEFAULT_MODEL
    • NerDetector
    • spacy_detector
    • NltkDetector
    • nltk_detector
    • FieldSpec
    • PackError
    • PackSpec
    • PATTERNS
    • PatternSpec
    • default_patterns
    • get_pattern
    • luhn_ok
    • CleanPlan
    • FluentCleanPrompt
    • DEFAULT_LIMITS
    • DEFAULT_POLICY
    • DEFAULT_TAG_STYLE
    • Limits
    • OverlapStrategy
    • RedactionPolicy
    • TagStyle
    • ANSI
    • highlight_placeholders
    • restoration_note
    • should_colorize
    • summary_table
    • Cleaner
    • Encoded
    • Item
    • Vault
    • decrypt_mapping
    • encrypt_mapping
  • scikitplot.config
    • __bibtex__
    • __citation__
  • scikitplot.corpus
    • to_langchain_documents
    • to_langgraph_state
    • to_mcp_resources
    • to_mcp_tool_result
    • to_huggingface_dataset
    • to_rag_tuples
    • to_jsonl
    • to_numpy_arrays
    • to_tensorflow_dataset
    • to_torch_dataloader
    • LangChainCorpusRetriever
    • MCPCorpusServer
    • AgenticRetrievalSession
    • BudgetPolicy
    • InvestigationOutcome
    • InvestigationStatus
    • RoutePlan
    • StopReason
    • SufficiencySignals
    • route
    • run_investigation
    • extract_archive
    • is_archive
    • ANNIndexArtifact
    • ArtifactError
    • ChunkerBase
    • DefaultFilter
    • DocumentReader
    • DummyReader
    • FilterBase
    • PipelineGuard
    • CapabilityStatus
    • capability_snapshot
    • distribution_version
    • probe_backend
    • ComponentCatalog
    • ComponentSpec
    • DiscoveryOutcome
    • DiscoveryStatus
    • component_catalog
    • ChunkedTextList
    • ChunkerBridge
    • FixedWindowChunkerBridge
    • ParagraphChunkerBridge
    • SemanticChunkerBridge
    • SentenceChunkerBridge
    • WordChunkerBridge
    • bridge_chunker
    • register_bridge
    • unregister_bridge
    • TokenizerProtocol
    • SentenceSplitterProtocol
    • StemmerProtocol
    • LemmatizerProtocol
    • FunctionTokenizer
    • FunctionSentenceSplitter
    • FunctionStemmer
    • FunctionLemmatizer
    • CustomTokenizerRegistry
    • register_tokenizer
    • get_tokenizer
    • register_sentence_splitter
    • get_sentence_splitter
    • register_stemmer
    • get_stemmer
    • register_lemmatizer
    • get_lemmatizer
    • ScriptType
    • detect_script
    • is_cjk_char
    • is_rtl_char
    • split_cjk_chars
    • _split_cjk_chars_legacy
    • MULTI_SCRIPT_SENTENCE_RE_PATTERN
    • ScriptSpan
    • ScriptSegmenter
    • FixedWindowChunker
    • FixedWindowChunkerConfig
    • WindowUnit
    • ISO_TO_NLTK
    • ISO_TO_NAME
    • NLTK_TO_ISO
    • NLTK_STOPWORD_LANGUAGES
    • BUILTIN_LANG_STOPWORDS
    • coerce_language
    • resolve_stopwords
    • iso_to_nltk
    • nltk_to_iso
    • MultilangConfig
    • MultilangMixin
    • ParagraphChunker
    • ParagraphChunkerConfig
    • SemanticBackend
    • SemanticChunker
    • SemanticChunkerConfig
    • SentenceBackend
    • SentenceChunker
    • SentenceChunkerConfig
    • _validate_text_input
    • LemmatizationBackend
    • StemmingBackend
    • StopwordSource
    • TokenizerBackend
    • WordChunker
    • WordChunkerConfig
    • ArabicMorphologicalStrategy
    • CJKCharacterStrategy
    • DeterminativeGroupStrategy
    • DictionaryBoundaryStrategy
    • EthiopicStrategy
    • GraphemeClusterStrategy
    • IndicAksharaStrategy
    • JapaneseStrategy
    • KoreanSyllableStrategy
    • MongolianStrategy
    • SegmentationStrategy
    • SpacePunctuationStrategy
    • TibetanStrategy
    • WritingSystemAdapter
    • WritingSystemAdapterConfig
    • BuildResult
    • BuilderConfig
    • CorpusBuilder
    • BuilderFactories
    • CustomChunker
    • CustomEnricherConfig
    • CustomFilter
    • CustomNLPEnricher
    • CustomNormalizer
    • CustomRetrievalIndex
    • FactoryCorpusBuilder
    • HookableCorpusPipeline
    • PipelineHooks
    • ErrorCategory
    • ErrorRecord
    • AnyDownloader
    • BaseDownloader
    • CustomDownloader
    • DownloadResult
    • GitHubDownloader
    • GoogleDriveDownloader
    • WebDownloader
    • YouTubeDownloader
    • DEFAULT_CACHE_DIR
    • DEFAULT_MODEL
    • EmbeddingEngine
    • HashEmbedder
    • DEFAULT_AUDIO_MODEL
    • DEFAULT_IMAGE_MODEL
    • DEFAULT_TEXT_MODEL
    • LLMTrainingExporter
    • MultimodalEmbeddingEngine
    • EmbeddingManifest
    • IncompatibleEmbeddingsError
    • BUILTIN_STOPWORDS
    • EnricherConfig
    • NLPEnricher
    • SimpleEnricherSpec
    • SimpleFrequencyEnricher
    • export_documents
    • load_documents
    • And
    • Eq
    • Exists
    • Filter
    • FilterCapability
    • In
    • Not
    • NotEq
    • NotIn
    • Or
    • Range
    • UnsupportedOperatorError
    • IndexGeneration
    • derive_generation
    • EdgeTrust
    • GraphEdge
    • GraphNode
    • GraphQuery
    • GraphResponse
    • NodeKind
    • RelationType
    • derive_graph
    • HierarchyReport
    • ancestors
    • children
    • descendants
    • validate_hierarchy
    • CollectionManifest
    • CorpusStats
    • compute_stats
    • provenance_from_filename
    • DedupLinesNormalizer
    • GraphemeClusterNormalizer
    • HTMLStripNormalizer
    • LanguageDetectionNormalizer
    • LowercaseNormalizer
    • NormalizationPipeline
    • NormalizerBase
    • UnicodeNormalizer
    • WhitespaceNormalizer
    • TextNormalizer
    • TextNormalizerConfig
    • normalize_text
    • CorpusPipeline
    • PipelineResult
    • create_corpus
    • CONFIG_DOMAINS
    • ConfigConflictError
    • CorpusPlan
    • FluentCorpus
    • ALTOReader
    • AudioReader
    • CustomReader
    • normalize_extractor_output
    • ImageReader
    • PDFReader
    • MarkdownReader
    • ReSTReader
    • TextReader
    • VideoReader
    • WebReader
    • YouTubeReader
    • TEIReader
    • XMLReader
    • ArchiveNestingError
    • ZipReader
    • ComponentRegistry
    • registry
    • LegKind
    • LegOutcome
    • LegStatus
    • RetrievalResponse
    • RetrievalStatus
    • DenseRetriever
    • GraphRetriever
    • LegContribution
    • LegResult
    • LexicalRetriever
    • Retriever
    • fuse_by_rank
    • RuntimeCorpus
    • RuntimePolicy
    • materialize_plan
    • HAMLET_TEXT
    • SectionType
    • ChunkingStrategy
    • ExportFormat
    • SourceType
    • MatchMode
    • Modality
    • ErrorPolicy
    • CorpusDocument
    • documents_to_pandas
    • documents_to_polars
    • DEFAULT_BACKEND_ORDER
    • AnnoyBackend
    • BruteForceBackend
    • FaissBackend
    • VectorIndexBackend
    • VoyagerBackend
    • list_available_backends
    • select_backend
    • RetrievalConfig
    • RetrievalHit
    • RetrievalIndex
    • CorpusSource
    • SourceEntry
    • SourceKind
    • FilterSupport
    • InMemoryStorage
    • JSONLStorage
    • QueryResult
    • SQLiteStorage
    • StorageBase
    • StorageQuery
    • MetadataDict
    • CharOffset
    • TokenId
    • BowVector
    • EmbeddingVector
    • DocumentStatus
    • ContentType
    • StorageBackend
    • NormalizerType
    • Chunk
    • ChunkResult
    • ChunkerConfig
    • SourceConfig
    • NormalizerConfigBase
    • StorageConfig
    • PipelineStep
    • PipelineConfig
    • EmbeddedChunk
    • RetrievalQuery
    • ChunkHit
    • CorpusRecord
    • ChunkerProtocol
    • NormalizerProtocol
    • SourceProtocol
    • StorageProtocol
    • ChunkerRegistration
    • ValidationError
    • ValidationResult
    • TrainingExample
    • TrainingDataset
    • ToolCallInput
    • ToolCallResult
    • SemantemeInfo
    • PreprocessingStep
    • PreprocessingTrace
    • MultilangChunkMeta
    • URLKind
    • classify_url
    • download_url
    • infer_extension
    • probe_url_kind
    • resolve_url
  • scikitplot.cython
    • API_STABILITY
    • Stability
    • api_stability
    • list_api
    • DEFAULT_COMPILER_DIRECTIVES
    • build_extension_module
    • build_extension_module_result
    • build_extension_package_from_code_result
    • build_extension_package_from_paths_result
    • CACHE_SCHEMA_VERSION
    • CacheEntry
    • PackageCacheEntry
    • find_entries_by_name
    • find_entry_by_key
    • find_package_entry_by_key
    • is_meta_schema_compatible
    • is_valid_key
    • iter_all_entry_dirs
    • iter_cache_entries
    • iter_package_entries
    • make_cache_key
    • meta_schema_version
    • peek_cache_dir
    • read_meta
    • register_artifact_path
    • resolve_cache_dir
    • runtime_fingerprint
    • source_digest
    • write_meta
    • CustomCompilerProtocol
    • CompilerRegistry
    • register_compiler
    • get_compiler
    • list_compilers
    • CompilerCapabilities
    • compiler_capabilities
    • COMPILER_SPEC_VERSION
    • pure_python_prereqs
    • cython_cpp_prereqs
    • full_stack_prereqs
    • pybind11_only_prereqs
    • c_api_prereqs
    • pybind11_include
    • numpy_include
    • collect_c_api_sources
    • collect_header_dirs
    • PybindCompiler
    • CApiCompiler
    • cache_stats
    • gc_cache
    • import_extension
    • import_extension_from_bytes
    • import_extension_from_path
    • build_lock
    • PinRegistryError
    • list_pins
    • pin
    • resolve_pinned_key
    • unpin
    • AppliedProfile
    • PlatformCapabilities
    • ProfileDefaults
    • ResolvedToolchain
    • RuntimeCapabilities
    • UnsupportedRuntimeError
    • apply_profile
    • check_runtime_supported
    • is_windows
    • platform_capabilities
    • resolve_profile
    • resolved_toolchain
    • runtime_capabilities
    • build_package_from_code
    • build_package_from_code_result
    • build_package_from_paths
    • build_package_from_paths_result
    • check_build_prereqs
    • compile_and_load
    • compile_and_load_result
    • cython_import
    • cython_import_all
    • cython_import_all_result
    • cython_import_result
    • export_cached
    • get_cache_dir
    • import_artifact_bytes
    • import_artifact_path
    • import_cached
    • import_cached_by_name
    • import_cached_package
    • import_cached_package_result
    • import_cached_result
    • import_pinned
    • import_pinned_result
    • list_cached
    • list_cached_packages
    • purge_cache
    • register_cached_artifact_bytes
    • register_cached_artifact_path
    • BatchBuildError
    • BatchBuildResult
    • BatchFailure
    • BuildResult
    • CacheGCResult
    • CacheStats
    • PackageBuildResult
    • DEFAULT_SECURITY_POLICY
    • RELAXED_SECURITY_POLICY
    • SecurityError
    • SecurityPolicy
    • is_safe_compiler_arg
    • is_safe_macro_name
    • is_safe_path
    • validate_build_inputs
    • TEMPLATE_SCHEMA_VERSION
    • TemplateInfo
    • TemplateValidationError
    • build_package_example
    • build_package_example_result
    • compile_template
    • compile_template_result
    • copy_workflow
    • generate_sphinx_template_docs
    • get_package_example_path
    • get_template_path
    • get_workflow_path
    • list_package_examples
    • list_templates
    • list_workflows
    • load_package_example_metadata
    • load_template_metadata
    • read_template
    • read_template_info
    • template_root
    • validate_template_info
    • verify_template_assets
    • workflow_cli_template_path
    • sanitize
  • scikitplot.datasets
    • get_data_home
    • get_dataset_names
    • load_dataset
  • scikitplot.decile
    • print_labels
    • decile_table
    • plot_cumulative_gain
    • plot_lift
    • plot_lift_decile_wise
    • plot_ks_statistic
    • report
    • ModelPlotPy
    • ModelPlotPy
    • summarize_selection
    • plot_response
    • plot_cumresponse
    • plot_cumlift
    • plot_cumgains
    • plot_all
    • plot_costsrevs
    • plot_profit
    • plot_roi
  • scikitplot.exceptions
    • ModuleDeprecationWarning
    • ScikitplotException
    • VisibleDeprecationWarning
  • scikitplot.impute
    • ANNImputer
  • scikitplot.levenshtein
    • BackendInfo
    • Match
    • available_backends
    • backend_info
    • closest
    • distance
    • make_corpus_scorer
    • normalized_distance
    • normalized_similarity
    • rank
    • similarity
  • scikitplot.logging
    • CRITICAL
    • DEBUG
    • ERROR
    • FATAL
    • INFO
    • NOTSET
    • WARN
    • WARNING
    • AlwaysStdErrHandler
    • GoogleLogFormatter
    • getEffectiveLevel
    • get_logger
    • get_verbosity
    • setLevel
    • set_verbosity
    • log
    • log_every_n
    • log_first_n
    • log_if
    • vlog
    • debug
    • info
    • warning
    • warn
    • error
    • error_log
    • exception
    • TaskLevelStatusMessage
    • critical
    • fatal
  • scikitplot.mcp
    • assert_capability_vocabulary_matches_corpus
    • effective_server_capabilities
    • server_capabilities
    • server_runtime_status
    • DOC_ID_RE
    • MAX_CHUNK_CHARS
    • MAX_QUERY_CHARS
    • MAX_RESOURCE_CHARS
    • MAX_RESULTS
    • RESOURCE_METADATA_ALLOWANCE
    • DocsRetriever
    • RetrievedChunk
    • SearchCoordinator
    • build_search_docs_result
    • is_valid_doc_id
    • CorpusAnnoyRetriever
    • CorpusIndexRetriever
    • Embedder
    • VectorIndex
    • DEFAULT_RRF_K
    • Bm25Retriever
    • HybridRetriever
    • reciprocal_rank_fusion
    • DemoDocument
    • InMemoryBm25Retriever
    • builtin_demo_retriever
    • CANCELLED
    • DEGRADED
    • EMPTY
    • FAILED
    • SUCCESS
    • LegRecord
    • RetrievalOutcome
    • assert_matches_corpus
    • to_corpus_status
    • CitationOutput
    • SearchDocsOutput
    • SearchService
    • create_server
  • scikitplot.memmap
    • MemoryMap
    • mmap_region
  • scikitplot.mlflow
    • DEFAULT_MLFLOW_SERVER_FLAGS
    • MlflowServerCliCaps
    • ensure_flags_supported
    • get_mlflow_server_cli_caps
    • import_mlflow
    • resolve_download_artifacts
    • ServerConfig
    • SessionConfig
    • running_in_docker
    • MlflowProvider
    • get_provider
    • set_provider
    • use_provider
    • EnvSnapshot
    • apply_env
    • parse_dotenv
    • MlflowCliIncompatibleError
    • MlflowIntegrationError
    • MlflowNotInstalledError
    • MlflowServerStartError
    • SecurityPolicyViolationError
    • ArtifactsFacade
    • ModelsFacade
    • DEFAULT_PROJECT_MARKERS
    • ProjectConfig
    • dump_project_config_yaml
    • ensure_local_store_layout
    • find_project_root
    • get_project_markers
    • load_project_config
    • load_project_config_toml
    • load_project_config_yaml
    • normalize_mlflow_store_values
    • project_markers
    • set_project_markers
    • wait_tracking_ready
    • DEFAULT_SECURITY_POLICY
    • RELAXED_SECURITY_POLICY
    • SecurityPolicy
    • get_security_policy
    • security_policy
    • set_security_policy
    • SpawnedServer
    • build_server_args
    • build_server_command
    • spawn_server
    • MlflowHandle
    • session
    • session_from_file
    • session_from_toml
    • MlflowVersion
    • is_mlflow_installed
    • mlflow_version
    • WorkflowPaths
    • builtin_config_path
    • default_project_paths
    • export_builtin_config
    • patch_experiment_name_in_toml
    • run_demo
    • workflow
  • scikitplot.nc
    • get_include
    • dot
  • scikitplot.preprocessing
    • DummyCodeEncoder
    • GetDummies
  • scikitplot.random
    • Kiss32Random
    • Kiss64Random
    • KissRandom
    • KissSeedSequence
    • KissBitGenerator
    • KissGenerator
    • KissRandomState
    • default_rng
    • kiss_context
    • choice
    • integers
    • normal
    • permutation
    • random
    • shuffle
    • uniform
  • scikitplot.rank_bm25
    • BM25
    • BM25Okapi
    • BM25L
    • BM25Plus
  • scikitplot.seaborn
    • aucplot
    • evalplot
    • modelplot
    • decileplot
    • print_labels
  • scikitplot.stats
    • Events
    • FitnessFunc
    • PointMeasures
    • RegularEvents
    • bayesian_blocks
    • binned_binom_proportion
    • binom_conf_interval
    • bootstrap
    • cdf_from_intervals
    • fold_intervals
    • gaussian_fwhm_to_sigma
    • gaussian_sigma_to_fwhm
    • histogram_intervals
    • interval_overlap_length
    • kuiper
    • kuiper_false_positive_probability
    • kuiper_two
    • mad_std
    • median_absolute_deviation
    • poisson_conf_interval
    • signal_to_noise_oir_ccd
    • calculate_bin_edges
    • freedman_bin_width
    • histogram
    • knuth_bin_width
    • scott_bin_width
    • akaike_info_criterion
    • akaike_info_criterion_lsq
    • bayesian_info_criterion
    • bayesian_info_criterion_lsq
    • tweedie_gen
    • tweedie
  • scikitplot.utils
    • Timer
    • PathNamer
    • make_path
  • scikitplot.visualkeras
    • graph_view
    • layered_view
    • SpacingDummyLayer
  • scikitplot.cexperimental
    • expit
    • log_expit
    • logit
    • py_print
    • sigmoid
    • softmax
    • logsumexp
    • log_softmax
  • scikitplot.experimental
    • scikitplot.experimental.enable_ann_imputer
    • pipeline
    • ENVELOPES
    • compose_as_waveform
    • play_waveform
    • plot_waveform
    • save_waveform
    • save_waveform_as_mp3
    • sheet_to_note
    • sheet_converter
    • serialize_sheet
    • export_sheet
  • scikitplot.cexternals
    • annoylib
    • Annoy
    • AnnoyIndex
    • stats
    • get_include
  • scikitplot.externals
    • ProbScale
    • probplot
    • plot_pos
    • fit_line
    • scikitplot.externals._sphinxext.figmpl_directive
    • scikitplot.externals._sphinxext.mathmpl
    • scikitplot.externals._sphinxext.plot_directive
    • roles
    • sphinx_tabs_patch
    • tweedie
    • tweedie_gen
  • scikitplot._externals
    • add_ai_assistant_context
    • generate_llms_txt
    • generate_llms_txt_standalone
    • generate_markdown_files
    • html_to_markdown
    • html_to_markdown_converter
    • process_html_directory
  • Recently Deprecated
    • _factory_api
    • plot_roc_curve
    • plot_precision_recall_curve
  • APIs Reference
  • scikitplot.corpus
  • In

In#

class scikitplot.corpus.In(field, values)[source]#

field in values.

Parameters:
  • field (str)

  • values (tuple[Any, ...])

describe()[source]#

Return a readable rendering of the expression.

Return type:

str

field: str[source]#
matches(document)[source]#

Whether the field’s value is among values.

Parameters:

document (Any)

Return type:

bool

operators()[source]#

Return {'In'}.

Return type:

set[str]

values: tuple[Any, ...][source]#

previous

FilterCapability

next

Not

On this page
  • In
    • describe
    • field
    • matches
    • operators
    • values
Edit on GitHub
Show Source

© Copyright 2024 - 2026 scikit-plots developers (BSD-3 Clause License) 0.5.dev0+git.20261011.0ec25c0 2026-10-11T11:42Z.