Skip to main content
Ctrl+K
Tumult Platform 0.20.1 documentation - Home Tumult Platform 0.20.1 documentation - Home
  • Installation
  • Tumult Analytics
  • Tumult Synthetics
  • Tumult Tune
  • Deployment
  • Release notes
  • GitLab
  • Slack
  • Installation
  • Tumult Analytics
  • Tumult Synthetics
  • Tumult Tune
  • Deployment
  • Release notes
  • GitLab
  • Slack

Tumult Platform

  • Installation
  • Tumult Analytics
    • Tutorials
      • First steps with Tumult Analytics
      • Working with privacy budgets
      • Numerical aggregations
      • Group-by queries
      • Simple transformations
      • Working with privacy IDs
      • Doing more with privacy IDs
    • Topic guides
      • Tumult Analytics’ privacy promise
      • Working with Sessions
      • Privacy budget fundamentals
      • Understanding sensitivity
      • Nulls, NaNs, and infinite values
    • API reference
      • Specifying privacy guarantees
        • Session
        • Session.from_dataframe
        • Session.Builder
        • ProtectedChange
        • AddOneRow
        • AddMaxRows
        • AddMaxRowsInMaxGroups
        • AddRowsWithID
        • PrivacyBudget
        • PureDPBudget
        • ApproxDPBudget
        • RhoZCDPBudget
        • Session.private_sources
        • Session.public_sources
        • Session.public_source_dataframes
        • Session.remaining_privacy_budget
        • Session.describe
        • Session.get_schema
        • Session.get_column_types
        • Session.get_grouping_column
        • Session.get_id_column
        • Session.get_id_space
      • Building queries
        • QueryBuilder
        • QueryBuilder.select
        • QueryBuilder.rename
        • QueryBuilder.replace_null_and_nan
        • QueryBuilder.drop_null_and_nan
        • QueryBuilder.replace_infinity
        • QueryBuilder.drop_infinity
        • QueryBuilder.filter
        • QueryBuilder.map
        • QueryBuilder.flat_map
        • QueryBuilder.flat_map_by_id
        • QueryBuilder.bin_column
        • BinningSpec
        • QueryBuilder.enforce
        • Constraint
        • MaxRowsPerID
        • MaxGroupsPerID
        • MaxRowsPerGroupPerID
        • QueryBuilder.join_public
        • QueryBuilder.join_private
        • QueryBuilder.groupby
        • KeySet
        • GroupedQueryBuilder
        • QueryBuilder.count
        • QueryBuilder.count_distinct
        • QueryBuilder.sum
        • QueryBuilder.average
        • QueryBuilder.variance
        • QueryBuilder.stdev
        • QueryBuilder.quantile
        • QueryBuilder.median
        • QueryBuilder.min
        • QueryBuilder.max
        • QueryBuilder.histogram
        • QueryBuilder.get_groups
        • QueryBuilder.get_bounds
        • Query
        • GroupbyCountQuery
        • GroupbyCountQuery.suppress
        • Session.evaluate
        • Session.create_view
        • Session.delete_view
        • Session.add_public_dataframe
        • Session.partition_and_create
        • Session.stop
        • ColumnType
        • ColumnDescriptor
        • AnalyticsDefault
      • Defining and using programs
        • SessionProgram
        • SessionProgram.Builder
        • SessionProgram.privacy_budget
        • SessionProgram.unprotected_inputs
        • SessionProgram.parameters
        • SessionProgram.output_types
        • SessionProgram.run
      • Configuration
        • Config
        • FeatureFlag
        • license_file_path_override
      • Utility functions and exceptions
        • check_installation
        • cleanup
        • remove_all_temp_tables
        • AnalyticsInternalError
  • Tumult Synthetics
    • Tutorial
    • Optimization guide
    • API reference
      • ClampingBounds
      • AutomaticBounds
      • PerGroupClampingBounds
      • MeasurementStrategy
      • FixedMarginals
      • AdaptiveMarginals
      • WeightedMarginal
      • Count
      • Sum
      • generate_synthetic_data
      • KeySetsRepository
      • MarginalAnswer
  • Tumult Tune
    • Tutorials
      • Basics of error measurement
      • Specifying error metrics
      • Tuning parameters
    • API reference
      • Tuning programs
        • SessionProgramTuner
        • SessionProgramTuner.baseline_options
        • baseline
        • SessionProgramTuner.views
        • View
        • view
        • SessionProgramTuner.metrics
        • SessionProgramTuner.Builder
        • Tunable
        • SessionProgramTuner.program
        • SessionProgramTuner.get_baselines
        • SessionProgramTuner.tunables
        • SessionProgramTuner.get_concrete_program
        • NamedValue
        • SessionProgramTuner.run
        • SessionProgramTuner.error_report
        • SessionProgramTuner.multi_error_report
        • RunOutputs
        • ProtectedInput
        • UnprotectedInput
        • ErrorReport
        • MultiErrorReport
        • NoPrivacySession
      • Measuring accuracy
        • QuantileAbsoluteError
        • MedianAbsoluteError
        • QuantileRelativeError
        • MedianRelativeError
        • HighRelativeErrorRate
        • HighRelativeErrorCount
        • SpuriousRate
        • SpuriousCount
        • SuppressionRate
        • SuppressionCount
        • CountDPRows
        • CountBaselineRows
        • metric
        • single_output_metric
        • joined_output_metric
        • Metric
        • SingleOutputMetric
        • JoinedOutputMetric
        • MetricResult
        • SingleOutputMetricResult
        • JoinedOutputMetricResult
  • Deployment
    • Using Tumult Analytics on AWS Glue
    • Using Tumult Analytics on Databricks
    • Spark configuration and performance
    • Troubleshooting
  • Release notes
  • Tumult Tune documentation
  • Tumult Tune API reference
  • Tuning programs
  • Tunable

Tunable#

from tmlt.tune import Tunable
class tmlt.tune.Tunable(name)#

Bases: object

Named placeholder for a single input to a SessionProgramTuner.Builder.

When a Tunable is passed to a SessionProgramTuner.Builder, it is replaced with the concrete values for the tunable parameter when building SessionProgram s inside of methods like error_report() and multi_error_report().

name: str#

Name of the tunable parameter.

previous

SessionProgramTuner.Builder

next

SessionProgramTuner.program

On this page
  • Tunable
    • Tunable.name

© Copyright 2025 Tumult Labs.

Built from 261afc2d at 2025-04-02 00:29.

Created using Sphinx 7.4.7.

Built with the PyData Sphinx Theme 0.16.1.