Class: Predict

Basic input-to-output predictor (dspy.Predict).

 classDiagram
    class Predict
    click Predict href "../Predict/"
      Predictor <|-- Predict
        click Predictor href "../Predictor/"


      Predict <|-- ChainOfThought
        click ChainOfThought href "../ChainOfThought/"


      Predict : callbacks

      Predict : compiled

      Predict : config





        Predict --> "0..1" Any : config
        click Any href "../Any/"



      Predict : demos





        Predict --> "*" Example : demos
        click Example href "../Example/"



      Predict : description

      Predict : history





        Predict --> "*" LMHistoryEntry : history
        click LMHistoryEntry href "../LMHistoryEntry/"



      Predict : id

      Predict : lm





        Predict --> "0..1" BaseLM : lm
        click BaseLM href "../BaseLM/"



      Predict : name

      Predict : predictors





        Predict --> "*" Predictor : predictors
        click Predictor href "../Predictor/"



      Predict : signature





        Predict --> "0..1" Signature : signature
        click Signature href "../Signature/"



      Predict : stage

      Predict : sub_modules





        Predict --> "*" Module : sub_modules
        click Module href "../Module/"



      Predict : traces





        Predict --> "*" Any : traces
        click Any href "../Any/"



      Predict : train





        Predict --> "*" Example : train
        click Example href "../Example/"

Inheritance

NamedThing
- Module
  - Predictor
    - Predict
      - ChainOfThought

Class Properties

Property	Value
Class URI	dspy:Predict

Slots

Name	Cardinality and Range	Description	Inheritance
signature	0..1 Signature	Signature attached to a predictor	Predictor
lm	0..1 BaseLM	Language model bound to this predictor / program	Predictor
config	0..1 Any	Default keyword arguments forwarded to the underlying LM	Predictor
stage	0..1 Identifier	Random per-predictor stage id used to bucket traces	Predictor
demos	* Example	Few-shot demonstrations attached to a predictor	Predictor
traces	* Any	Bootstrapped traces gathered by teleprompters	Predictor
train	* Example	Training examples attached to a predictor (used by some optimizers)	Predictor
compiled	0..1 Boolean	Whether the module has been compiled by a teleprompter	Module
callbacks	* String	Dotted import paths of callbacks registered on the module	Module
history	* LMHistoryEntry	Per-module call history of LM requests / responses	Module
predictors	* Predictor	Predictor children of a composite Module (named_predictors())	Module
sub_modules	* Module	Nested Module children of a composite Module	Module
id	1 Identifier	Stable opaque identifier for an instance	NamedThing
name	0..1 String	Short human-readable name	NamedThing
description	0..1 String	Free-form description	NamedThing

In Subsets

Modules

Identifier and Mapping Information

Annotations

property	value
dspy_source_paths	['dspy/predict/predict.py']
dspy_source_urls	['https://github.com/stanfordnlp/dspy/blob/main/dspy/predict/predict.py']

Schema Source

from schema: https://w3id.org/lmodel/dspy

Mappings

Mapping Type	Mapped Value
self	dspy:Predict
native	dspy:Predict
related	ai:NaturalLanguageGeneration, iso42001:MLApproach, uco_action:Action
close	ai:AIProcess, nexus:AIComponent, mellea:ComponentSpec

LinkML Source

Direct

name: Predict
annotations:
  dspy_source_paths:
    tag: dspy_source_paths
    value:
    - dspy/predict/predict.py
  dspy_source_urls:
    tag: dspy_source_urls
    value:
    - https://github.com/stanfordnlp/dspy/blob/main/dspy/predict/predict.py
description: Basic input-to-output predictor (``dspy.Predict``).
in_subset:
- modules
from_schema: https://w3id.org/lmodel/dspy
close_mappings:
- ai:AIProcess
- nexus:AIComponent
- mellea:ComponentSpec
related_mappings:
- ai:NaturalLanguageGeneration
- iso42001:MLApproach
- uco_action:Action
is_a: Predictor
class_uri: dspy:Predict

Induced

name: Predict
annotations:
  dspy_source_paths:
    tag: dspy_source_paths
    value:
    - dspy/predict/predict.py
  dspy_source_urls:
    tag: dspy_source_urls
    value:
    - https://github.com/stanfordnlp/dspy/blob/main/dspy/predict/predict.py
description: Basic input-to-output predictor (``dspy.Predict``).
in_subset:
- modules
from_schema: https://w3id.org/lmodel/dspy
close_mappings:
- ai:AIProcess
- nexus:AIComponent
- mellea:ComponentSpec
related_mappings:
- ai:NaturalLanguageGeneration
- iso42001:MLApproach
- uco_action:Action
is_a: Predictor
attributes:
  signature:
    name: signature
    description: Signature attached to a predictor.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: Predict
    domain_of:
    - Completions
    - Predictor
    range: Signature
    inlined: true
  lm:
    name: lm
    description: Language model bound to this predictor / program.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: Predict
    domain_of:
    - Predictor
    - RLM
    - Settings
    range: BaseLM
    inlined: true
  config:
    name: config
    description: Default keyword arguments forwarded to the underlying LM.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: Predict
    domain_of:
    - LMRequest
    - Predictor
    range: Any
  stage:
    name: stage
    description: Random per-predictor stage id used to bucket traces.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: Predict
    domain_of:
    - Predictor
    range: Identifier
  demos:
    name: demos
    description: Few-shot demonstrations attached to a predictor.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: Predict
    domain_of:
    - Predictor
    range: Example
    multivalued: true
    inlined: true
    inlined_as_list: true
  traces:
    name: traces
    description: Bootstrapped traces gathered by teleprompters.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: Predict
    domain_of:
    - Predictor
    range: Any
    multivalued: true
  train:
    name: train
    description: Training examples attached to a predictor (used by some optimizers).
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: Predict
    domain_of:
    - Predictor
    range: Example
    multivalued: true
    inlined: true
    inlined_as_list: true
  compiled:
    name: compiled
    description: Whether the module has been compiled by a teleprompter.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    ifabsent: boolean(False)
    owner: Predict
    domain_of:
    - Module
    range: boolean
  callbacks:
    name: callbacks
    description: Dotted import paths of callbacks registered on the module.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: Predict
    domain_of:
    - BaseLM
    - Adapter
    - Module
    - Settings
    range: string
    multivalued: true
  history:
    name: history
    description: Per-module call history of LM requests / responses.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: Predict
    domain_of:
    - BaseLM
    - Module
    range: LMHistoryEntry
    multivalued: true
    inlined: true
    inlined_as_list: true
  predictors:
    name: predictors
    description: Predictor children of a composite Module (named_predictors()).
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: Predict
    domain_of:
    - Module
    range: Predictor
    multivalued: true
    inlined: true
    inlined_as_list: true
  sub_modules:
    name: sub_modules
    description: Nested Module children of a composite Module.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: Predict
    domain_of:
    - Module
    range: Module
    multivalued: true
    inlined: true
    inlined_as_list: true
  id:
    name: id
    description: Stable opaque identifier for an instance.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    slot_uri: schema:identifier
    identifier: true
    owner: Predict
    domain_of:
    - NamedThing
    range: Identifier
    required: true
  name:
    name: name
    description: Short human-readable name.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    slot_uri: rdfs:label
    owner: Predict
    domain_of:
    - NamedThing
    - LMToolCallPart
    - LMMessage
    - LMToolSpec
    range: string
  description:
    name: description
    description: Free-form description.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    slot_uri: dct:description
    owner: Predict
    domain_of:
    - NamedThing
    - LMToolSpec
    range: string
class_uri: dspy:Predict