Skip to content

skill

Classes:

BaseSkill 

BaseSkill(metadata: SkillMetadata)

Methods:

Source code in src/hiperhealth/pipeline/skill.py 
114
115
116
117
118
119
120
121
def __init__(self, metadata: SkillMetadata) -> None:
    """
    title: Initialize a base skill with immutable metadata.
    parameters:
      metadata:
        type: SkillMetadata
    """
    self.metadata = metadata

check_requirements 

check_requirements(
    stage: str, ctx: PipelineContext
) -> list[Inquiry]

Override to return a list of Inquiry objects describing what additional data the skill needs. The default implementation returns an empty list (no extra data needed). Inquiries use three priority levels: - required: must have before this stage can run - supplementary: improves results, available now - deferred: only available after a future pipeline step parameters: stage: type: str ctx: type: PipelineContext returns: type: list[Inquiry]

Source code in src/hiperhealth/pipeline/skill.py 
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
def check_requirements(
    self, stage: str, ctx: PipelineContext
) -> list[Inquiry]:
    """
    title: Determine what information is needed before execution.
    summary: |-
      Override to return a list of Inquiry objects describing
      what additional data the skill needs.  The default
      implementation returns an empty list (no extra data needed).
      Inquiries use three priority levels:
      - required: must have before this stage can run
      - supplementary: improves results, available now
      - deferred: only available after a future pipeline step
    parameters:
      stage:
        type: str
      ctx:
        type: PipelineContext
    returns:
      type: list[Inquiry]
    """
    return []

execute 

execute(
    stage: str, ctx: PipelineContext
) -> PipelineContext
Source code in src/hiperhealth/pipeline/skill.py 
159
160
161
162
163
164
165
166
167
168
169
170
def execute(self, stage: str, ctx: PipelineContext) -> PipelineContext:
    """
    title: The main execution hook for a stage.
    parameters:
      stage:
        type: str
      ctx:
        type: PipelineContext
    returns:
      type: PipelineContext
    """
    return ctx

post 

post(stage: str, ctx: PipelineContext) -> PipelineContext
Source code in src/hiperhealth/pipeline/skill.py 
172
173
174
175
176
177
178
179
180
181
182
183
def post(self, stage: str, ctx: PipelineContext) -> PipelineContext:
    """
    title: Called after the stage's main execution.
    parameters:
      stage:
        type: str
      ctx:
        type: PipelineContext
    returns:
      type: PipelineContext
    """
    return ctx

pre 

pre(stage: str, ctx: PipelineContext) -> PipelineContext
Source code in src/hiperhealth/pipeline/skill.py 
146
147
148
149
150
151
152
153
154
155
156
157
def pre(self, stage: str, ctx: PipelineContext) -> PipelineContext:
    """
    title: Called before the stage's main execution.
    parameters:
      stage:
        type: str
      ctx:
        type: PipelineContext
    returns:
      type: PipelineContext
    """
    return ctx

Skill

Bases: Protocol

Methods:

check_requirements 

check_requirements(
    stage: str, ctx: PipelineContext
) -> list[Inquiry]
Source code in src/hiperhealth/pipeline/skill.py 
48
49
50
51
52
53
54
55
56
57
58
59
60
61
def check_requirements(
    self, stage: str, ctx: PipelineContext
) -> list[Inquiry]:
    """
    title: Describe what information the skill still needs.
    parameters:
      stage:
        type: str
      ctx:
        type: PipelineContext
    returns:
      type: list[Inquiry]
    """
    ...

execute 

execute(
    stage: str, ctx: PipelineContext
) -> PipelineContext
Source code in src/hiperhealth/pipeline/skill.py 
76
77
78
79
80
81
82
83
84
85
86
87
def execute(self, stage: str, ctx: PipelineContext) -> PipelineContext:
    """
    title: Run the main execution hook for a stage.
    parameters:
      stage:
        type: str
      ctx:
        type: PipelineContext
    returns:
      type: PipelineContext
    """
    ...

post 

post(stage: str, ctx: PipelineContext) -> PipelineContext
Source code in src/hiperhealth/pipeline/skill.py 
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
def post(self, stage: str, ctx: PipelineContext) -> PipelineContext:
    """
    title: Run the post-execution hook for a stage.
    parameters:
      stage:
        type: str
      ctx:
        type: PipelineContext
    returns:
      type: PipelineContext
    """
    ...

pre 

pre(stage: str, ctx: PipelineContext) -> PipelineContext
Source code in src/hiperhealth/pipeline/skill.py 
63
64
65
66
67
68
69
70
71
72
73
74
def pre(self, stage: str, ctx: PipelineContext) -> PipelineContext:
    """
    title: Run the pre-execution hook for a stage.
    parameters:
      stage:
        type: str
      ctx:
        type: PipelineContext
    returns:
      type: PipelineContext
    """
    ...

SkillMetadata dataclass 

SkillMetadata(
    name: str,
    version: str = '0.1.0',
    stages: tuple[str, ...] = (),
    description: str = '',
)