Hide navigation sidebar

Hide table of contents sidebar

Toggle site navigation sidebar

Toggle table of contents sidebar

Getting Started
Toggle navigation of Getting Started
- PyGlove: A Bird View
- For Python
  Toggle navigation of For Python
- For Machine Learning
  Toggle navigation of For Machine Learning
- For AutoML
  Toggle navigation of For AutoML
- For Evolution
  Toggle navigation of For Evolution
Learning PyGlove
Toggle navigation of Learning PyGlove
- SOOP
  Toggle navigation of SOOP
- Evolution
  Toggle navigation of Evolution

API References

Public API: pyglove
Toggle navigation of Public API: pyglove
- pg.detouring
  Toggle navigation of pg.detouring
- pg.geno
  Toggle navigation of 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
  Toggle navigation of 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
  Toggle navigation of pg.io
  - File
  - FileSystem
  - MemoryFile
  - MemoryFileSystem
  - StdFile
  - StdFileSystem
  - add_file_system
  - isdir
  - listdir
  - mkdir
  - mkdirs
  - open
  - path_exists
  - readfile
  - rm
  - rmdir
  - rmdirs
  - writefile
- pg.object_utils
  Toggle navigation of pg.object_utils
- pg.patching
  Toggle navigation of pg.patching
- pg.symbolic
  Toggle navigation of pg.symbolic
- pg.tuning
  Toggle navigation of pg.tuning
- pg.typing
  Toggle navigation of 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
  - PrimitiveType
  - Schema
  - Sequence
  - Signature
  - Str
  - StrKey
  - Tuple
  - TupleKey
  - Type
  - Union
  - ValueSpec
  - callable_eq
  - create_field
  - create_schema
  - ensure_value_spec
  - get_arg_fields
  - get_converter
  - get_json_value_converter
  - get_signature
  - get_type
  - get_type_args
  - has_generic_bases
  - is_generic
  - is_instance
  - is_subclass
  - register_converter
- pg.early_stopping
  Toggle navigation of pg.early_stopping
- pg.evolution
  Toggle navigation of pg.evolution
  - mutators
    Toggle navigation of mutators
  - recombinators
    Toggle navigation of recombinators
    - Average
    - Cycle
    - KPoint
    - Numeric
    - Order
    - PartiallyMapped
    - Permutation
    - PointWise
    - Sample
    - SegmentWise
    - Segmented
    - Uniform
    - WeightedAverage
  - selectors
    Toggle navigation of 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
  Toggle navigation of 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
  Toggle navigation of 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)

v: latest

Versions: latest; stable; v0.2.1

Downloads

On Read the Docs: Project Home; Builds

Toggle table of contents sidebar

pg.object_utils.DocStrEntry¶

Accessible via pg.object_utils.DocStrEntry.

class DocStrEntry(description)[source]¶

Bases: object

An entry in a docstring.

pg.object_utils.DocStrExample

pg.object_utils.DocStrArgument

Copyright © Copyright 2023, The PyGlove Authors

Made with Sphinx and @pradyunsg's Furo

On this page

pg.object_utils.DocStrEntry
- DocStrEntry