Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
PyGlove
Light Logo Dark Logo
  • Getting Started
    • PyGlove: A Bird View
    • For Python
      • Flexible Function Bindings
      • Runtime Typing
      • Direct Manipulation
      • Domain-Specific Languages
      • Context-aware Components
    • For Machine Learning
      • Symbolic Modeling
      • Symbolic Machine Learning
      • Patching: Efficiently Exchangeing ML Ideas
    • For AutoML
      • Toy Problems
      • Industrial Uses
      • Research
    • For Evolution
      • One-Max Problem
      • Travelling Salesman Problem
      • Function Regression
  • Learning PyGlove
    • SOOP
      • Symbolic Object
      • Symbolic Types
      • Symbolic Operations
      • Symbolic Events
      • Symbolic Validation
      • Symbolic Placeholding
      • Symbolic Detour
    • Evolution
      • Algorithm
      • Operations
      • Fine Control

API References

  • Public API: pyglove
    • pg.detouring
      • current_mappings
      • detour
      • undetoured_new
    • pg.geno
      • AttributeDict
      • Choices
      • ConditionalKey
      • CustomDecisionPoint
      • DNA
      • DNAGenerator
      • DNASpec
      • DecisionPoint
      • Deduping
      • Float
      • Random
      • Space
      • Sweeping
      • space
      • constant
      • custom
      • dna_generator
      • float_scale_spec
      • floatv
      • manyof
      • oneof
      • random_dna
    • pg.hyper
      • ChoiceList
      • ChoiceValue
      • Choices
      • CustomHyper
      • DerivedValue
      • DynamicEvaluationContext
      • Evolvable
      • Float
      • HyperPrimitive
      • HyperValue
      • ManyOf
      • MutationPoint
      • MutationType
      • ObjectTemplate
      • OneOf
      • Template
      • ValueReference
      • dna_spec
      • dynamic_evaluate
      • evolve
      • float_value
      • floatv
      • iterate
      • manyof
      • materialize
      • one_of
      • oneof
      • permutate
      • random_sample
      • reference
      • search_space
      • sublist_of
      • template
      • trace
    • pg.io
      • fsspec
      • File
      • FileSystem
      • FsspecFile
      • FsspecFileSystem
      • LineSequence
      • LineSequenceIO
      • MemoryFile
      • MemoryFileSystem
      • MemorySequence
      • MemorySequenceIO
      • Sequence
      • SequenceIO
      • StdFile
      • StdFileSystem
      • add_file_system
      • add_sequence_io
      • chmod
      • copy
      • getctime
      • getmtime
      • glob
      • isdir
      • listdir
      • mkdir
      • mkdirs
      • open
      • open_sequence
      • path_exists
      • readfile
      • rename
      • resolve_path
      • rm
      • rmdir
      • rmdirs
      • writefile
    • pg.patching
      • ObjectFactory
      • Patcher
      • allow_repeated_patcher_registration
      • from_maybe_serialized
      • from_uri
      • patch
      • patch_on_key
      • patch_on_member
      • patch_on_path
      • patch_on_type
      • patch_on_value
      • patcher
      • patcher_names
    • pg.symbolic
      • ClassWrapper
      • ContextualAttribute
      • ContextualObject
      • DescendantQueryOption
      • Dict
      • Diff
      • ErrorInfo
      • FieldUpdate
      • Functor
      • Inferential
      • InferredValue
      • Insertion
      • List
      • NonDeterministic
      • Object
      • ObjectMeta
      • Origin
      • PureSymbolic
      • Ref
      • Symbolic
      • TraverseAction
      • UnknownFunction
      • UnknownMethod
      • UnknownSymbol
      • UnknownType
      • UnknownTypedObject
      • ValueFromParentChain
      • WritePermissionError
      • allow_empty_field_description
      • allow_partial
      • allow_repeated_class_registration
      • allow_writable_accessors
      • apply_wrappers
      • as_functor
      • as_sealed
      • auto_call_functors
      • boilerplate_class
      • clone
      • compound
      • compound_class
      • contains
      • contextual_attribute
      • default_load_handler
      • default_save_handler
      • deref
      • diff
      • enable_type_check
      • eq
      • from_json
      • from_json_str
      • functor
      • functor_class
      • get_load_handler
      • get_origin_stacktrace_limit
      • get_save_handler
      • gt
      • hash
      • is_abstract
      • is_change_notification_enabled
      • is_deterministic
      • is_empty_field_description_allowed
      • is_pure_symbolic
      • is_repeated_class_registration_allowed
      • is_tracking_origin
      • is_type_check_enabled
      • is_under_accessor_writable_scope
      • is_under_partial_scope
      • is_under_sealed_scope
      • load
      • lt
      • mark_as_insertion
      • maybe_ref
      • members
      • ne
      • notify_on_change
      • open_jsonl
      • query
      • save
      • set_load_handler
      • set_origin_stacktrace_limit
      • set_save_handler
      • should_call_functors_during_init
      • symbolize
      • to_json
      • to_json_str
      • track_origin
      • traverse
      • use_init_args
      • wrap
      • wrap_module
    • pg.tuning
      • Backend
      • EarlyStoppingPolicy
      • Feedback
      • Measurement
      • RaceConditionError
      • Result
      • Trial
      • add_backend
      • available_backends
      • default_backend
      • poll_result
      • sample
      • set_default_backend
    • pg.typing
      • MISSING_VALUE
      • Annotated
      • Any
      • Argument
      • Bool
      • Callable
      • CallableType
      • CallableWithOptionalKeywordArgs
      • ConstStrKey
      • CustomTyping
      • Dict
      • Enum
      • Field
      • Float
      • ForwardRef
      • Functor
      • Generic
      • GenericMeta
      • GenericTypeAlias
      • Int
      • KeySpec
      • List
      • ListKey
      • MissingValue
      • NonConstKey
      • Number
      • Object
      • Optional
      • PresetArgValue
      • PrimitiveType
      • Schema
      • Sequence
      • Signature
      • Str
      • StrKey
      • Tuple
      • TupleKey
      • Type
      • Union
      • ValueSpec
      • annotation_from_str
      • callable_eq
      • create_field
      • create_schema
      • enable_preset_args
      • ensure_value_spec
      • get_converter
      • get_json_value_converter
      • get_outer_class
      • get_signature
      • get_type
      • get_type_args
      • has_generic_bases
      • is_generic
      • is_instance
      • is_subclass
      • preset_args
      • register_converter
      • schema
      • signature
      • to_json_schema
    • pg.utils
      • MISSING_VALUE
      • BracketType
      • CatchErrorsContext
      • ContextualOverride
      • DocStr
      • DocStrArgument
      • DocStrEntry
      • DocStrExample
      • DocStrRaises
      • DocStrReturns
      • DocStrStyle
      • ErrorInfo
      • Formattable
      • Functor
      • JSONConversionContext
      • JSONConvertible
      • KeyPath
      • KeyPathSet
      • MaybePartial
      • MissingValue
      • RawText
      • StrKey
      • TimeIt
      • all_contextual_values
      • auto_plural
      • bracket_chars
      • camel_to_snake
      • canonicalize
      • catch_errors
      • colored
      • colored_block
      • comma_delimited_str
      • contextual_override
      • contextual_value
      • decolor
      • docstr
      • ensure_explicit_method_override
      • explicit_method_override
      • flatten
      • format
      • from_json
      • get_contextual_override
      • is_partial
      • kvlist_str
      • match_error
      • maybe_markdown_quote
      • merge
      • merge_tree
      • message_on_path
      • print
      • quote_if_str
      • registered_types
      • repr_format
      • str_format
      • thread_local_decrement
      • thread_local_del
      • thread_local_get
      • thread_local_has
      • thread_local_increment
      • thread_local_peek
      • thread_local_pop
      • thread_local_push
      • thread_local_set
      • thread_local_value_scope
      • timeit
      • to_json
      • transform
      • traverse
      • try_listify_dict_with_int_keys
      • with_contextual_override
    • pg.views
      • Html
      • HtmlConvertible
      • HtmlTreeView
      • HtmlView
      • View
      • to_html
      • to_html_str
      • view
      • view_options
    • pg.early_stopping
      • And
      • EarlyStopingPolicyBase
      • Not
      • Or
      • StepWise
      • early_stop_by_rank
      • early_stop_by_value
    • pg.evolution
      • mutators
        • Swap
        • Uniform
        • where_fn_spec
      • recombinators
        • Average
        • Cycle
        • KPoint
        • Numeric
        • Order
        • PartiallyMapped
        • Permutation
        • PointWise
        • Sample
        • SegmentWise
        • Segmented
        • Uniform
        • WeightedAverage
      • selectors
        • Bottom
        • First
        • Last
        • Proportional
        • Random
        • Sample
        • Top
        • compute_num_output
        • num_output_spec
      • Choice
      • Concatenation
      • Conditional
      • DNAOperation
      • Difference
      • ElementWise
      • Evolution
      • Flatten
      • GlobalStateGetter
      • GlobalStateSetter
      • Identity
      • Intersection
      • Inversion
      • Lambda
      • Mutator
      • Operation
      • Pipeline
      • Power
      • Recombinator
      • Repeat
      • Scalar
      • Selector
      • Slice
      • SymmetricDifference
      • Union
      • UntilChange
      • RegularizedEvolution
      • get_feedback_sequence_number
      • get_fitness
      • get_generation_id
      • hill_climb
      • is_initial_population
      • neat
      • nsga2
      • regularized_evolution
      • scalar_spec
      • scalar_value
      • set_fitness
    • pg.mutfun
      • Add
      • Assign
      • BinaryOperator
      • Code
      • Divide
      • Equals
      • FloorDivide
      • Function
      • FunctionCall
      • GreaterThan
      • Instruction
      • LessThan
      • Mod
      • Multiply
      • Negate
      • NotEquals
      • Operator
      • Power
      • Substract
      • SymbolDefinition
      • SymbolReference
      • UnaryOperator
      • Var
      • evaluate
      • python_repr
    • pg.scalars
      • STEP
      • Absolute
      • Addition
      • BinaryOp
      • Ceiling
      • Constant
      • Cosine
      • Division
      • Exp
      • Floor
      • Gaussian
      • Lambda
      • Log
      • LogNormal
      • Mod
      • Multiplication
      • Negation
      • Normal
      • Power
      • RandomScalar
      • Scalar
      • Sine
      • SquareRoot
      • StepWise
      • Substraction
      • Triangular
      • UnaryOp
      • Uniform
      • cos
      • exp
      • log
      • sin
      • sqrt
      • cosine_decay
      • cyclic
      • exponential_decay
      • linear
      • make_scalar
      • scalar_spec
      • scalar_value
  • API Index (A-Z)
Back to top
View this page

Welcome to PyGlove¶

  • Getting Started
    • PyGlove: A Bird View
    • For Python
    • For Machine Learning
    • For AutoML
    • For Evolution
  • Learning PyGlove
    • SOOP
    • Evolution

API References

  • Public API: pyglove
    • Modules
    • Top-level shortcurts
  • API Index (A-Z)
Next
Getting Started
Copyright © Copyright 2023, The PyGlove Authors
Made with Sphinx and @pradyunsg's Furo