term_cleaner
TermCleaner
A class to clean clinical terms by removing non-essential modifiers and information using a Large Language Model (LLM).
Source code in src/ariadne/term_cleanup/term_cleaner.py
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 | |
clean_terms(df, term_column='source_term', output_column='cleaned_term', vocabulary_column='source_vocabulary_id', code_column='source_concept_code')
Cleans clinical terms in a DataFrame column.
LLM cleanup runs first, then the and/or rewrite is applied to the cleaned terms. Running the rewrite last keeps it deterministic, since the LLM cannot collapse ' and/or ' back to ' and '.
term_column, vocabulary_column, and code_column are all required and must be present in df; a ValueError is raised otherwise.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
df
|
DataFrame
|
DataFrame containing the terms to be cleaned. |
required |
term_column
|
str
|
Column with source terms. |
'source_term'
|
output_column
|
str
|
Column to write cleaned terms to. |
'cleaned_term'
|
vocabulary_column
|
str
|
Column with the source vocabulary id. |
'source_vocabulary_id'
|
code_column
|
str
|
Column with the source concept code. |
'source_concept_code'
|
Returns:
| Type | Description |
|---|---|
DataFrame
|
DataFrame with cleaned terms in output_column. |
Source code in src/ariadne/term_cleanup/term_cleaner.py
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 | |
get_total_cost()
Returns the total cost incurred for LLM calls during term cleaning.
Returns:
| Type | Description |
|---|---|
float
|
Total cost in USD. |
Source code in src/ariadne/term_cleanup/term_cleaner.py
221 222 223 224 225 226 227 228 229 | |
rewrite_and(term, vocabulary_id='', concept_code='')
Rewrite ' and ' → ' and/or ' for ICD-family terms where appropriate. Args: term: The clinical term to be cleaned. vocabulary_id: Source vocabulary (e.g. 'ICD10CM'). Used for the and/or rewrite; safe to omit for non-ICD terms. concept_code: Source concept code. Used for and/or rewrite exclusions; safe to omit.
Returns:
| Type | Description |
|---|---|
str
|
The cleaned clinical term. |
Source code in src/ariadne/term_cleanup/term_cleaner.py
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 | |