Skip to main content

o41_training_data/
config.rs

1use anyhow::{Result, ensure};
2use serde::{Deserialize, Serialize};
3
4#[derive(Clone, Debug, Deserialize, Serialize)]
5#[serde(rename_all = "camelCase", deny_unknown_fields)]
6pub struct Source {
7    pub uri: String,
8    #[serde(default, skip_serializing_if = "Option::is_none")]
9    pub etag: Option<String>,
10    #[serde(default, skip_serializing_if = "Option::is_none")]
11    pub size_bytes: Option<u64>,
12    #[serde(default, skip_serializing_if = "Option::is_none")]
13    pub rows: Option<usize>,
14}
15/// Explicit object-store settings. Nothing is read from the environment.
16#[derive(Clone, Debug, Deserialize, Serialize, Default)]
17#[serde(rename_all = "camelCase", deny_unknown_fields)]
18pub struct Storage {
19    #[serde(default, skip_serializing_if = "Option::is_none")]
20    pub base_url: Option<String>,
21    #[serde(default, skip_serializing_if = "Option::is_none")]
22    pub region: Option<String>,
23    #[serde(default, skip_serializing_if = "Option::is_none")]
24    pub access_key_id: Option<String>,
25    #[serde(default, skip_serializing_if = "Option::is_none")]
26    pub secret_access_key: Option<String>,
27    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
28    pub virtual_hosted_style_request: bool,
29}
30impl Storage {
31    pub fn without_credentials(&self) -> Self {
32        Self {
33            access_key_id: None,
34            secret_access_key: None,
35            ..self.clone()
36        }
37    }
38}
39#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
40#[serde(deny_unknown_fields)]
41pub struct Field {
42    pub name: String,
43    pub from: String,
44    pub dtype: String,
45    #[serde(default, skip_serializing_if = "Option::is_none")]
46    pub length: Option<usize>,
47    #[serde(default, skip_serializing_if = "Option::is_none")]
48    pub shape: Option<Vec<usize>>,
49    #[serde(default, skip_serializing_if = "Option::is_none")]
50    pub pad: Option<serde_json::Value>,
51}
52impl Field {
53    pub fn dimensions(&self) -> Vec<usize> {
54        self.shape
55            .clone()
56            .unwrap_or_else(|| self.length.into_iter().collect())
57    }
58    pub fn width(&self) -> usize {
59        self.dimensions().iter().product()
60    }
61}
62/// One weighted source of a stage: either resolved `files` or a manifest
63/// reference that `manifest::resolve` turns into files.
64#[derive(Clone, Debug, Deserialize, Serialize)]
65#[serde(rename_all = "camelCase", deny_unknown_fields)]
66pub struct Group {
67    #[serde(default, skip_serializing_if = "Option::is_none")]
68    pub encoding: Option<String>,
69    #[serde(default, skip_serializing_if = "Option::is_none")]
70    pub fields: Option<Vec<Field>>,
71    #[serde(default, skip_serializing_if = "Vec::is_empty")]
72    pub files: Vec<Source>,
73    #[serde(default, skip_serializing_if = "Option::is_none")]
74    pub manifest_uri: Option<String>,
75    #[serde(default, skip_serializing_if = "Option::is_none")]
76    pub split: Option<String>,
77    #[serde(default, skip_serializing_if = "Vec::is_empty")]
78    pub curriculum_stages: Vec<String>,
79    #[serde(default, skip_serializing_if = "Option::is_none")]
80    pub weight: Option<f64>,
81}
82#[derive(Clone, Debug, Deserialize, Serialize)]
83#[serde(rename_all = "camelCase", deny_unknown_fields)]
84pub struct Shuffle {
85    pub buffer_rows: usize,
86}
87#[derive(Clone, Debug, Deserialize, Serialize)]
88#[serde(rename_all = "camelCase", deny_unknown_fields)]
89pub struct Stage {
90    #[serde(default, skip_serializing_if = "Option::is_none")]
91    pub encoding: Option<String>,
92    pub sources: Vec<Group>,
93    pub batch_size: usize,
94    #[serde(default, skip_serializing_if = "Option::is_none")]
95    pub shuffle: Option<Shuffle>,
96    pub infinite: bool,
97    #[serde(default)]
98    pub drop_last: bool,
99}
100#[derive(Clone, Debug, Deserialize, Serialize)]
101#[serde(rename_all = "camelCase", deny_unknown_fields)]
102pub struct Config {
103    #[serde(default)]
104    pub storage: Storage,
105    pub stages: Vec<Stage>,
106    pub fields: Vec<Field>,
107    pub seed: u64,
108    pub rank: u64,
109    pub world_size: u64,
110    pub threads: usize,
111    pub prefetch_batches: usize,
112    #[serde(default = "lookahead")]
113    pub lookahead: usize,
114    #[serde(default, skip_serializing_if = "Option::is_none")]
115    pub memory_limit_bytes: Option<u64>,
116    #[serde(default = "record_limit")]
117    pub max_record_bytes: usize,
118    #[serde(default = "row_group_limit")]
119    pub max_row_group_bytes: usize,
120    #[serde(default = "row_limit")]
121    pub max_shard_rows: usize,
122}
123fn lookahead() -> usize {
124    2
125}
126fn record_limit() -> usize {
127    4 * 1024 * 1024
128}
129fn row_group_limit() -> usize {
130    64 * 1024 * 1024
131}
132fn row_limit() -> usize {
133    65536
134}
135impl Config {
136    pub fn memory_limit(&self) -> Result<u64> {
137        if let Some(limit) = self.memory_limit_bytes {
138            return Ok(limit);
139        }
140        let pages = unsafe { libc::sysconf(libc::_SC_PHYS_PAGES) };
141        let page_size = unsafe { libc::sysconf(libc::_SC_PAGESIZE) };
142        ensure!(
143            pages > 0 && page_size > 0,
144            "cannot read host physical memory"
145        );
146        Ok(((pages as u128 * page_size as u128) / 2).try_into()?)
147    }
148    pub fn memory_bound(&self) -> Result<u64> {
149        let groups: Vec<_> = self.stages.iter().flat_map(|s| &s.sources).collect();
150        let row: u128 = self
151            .fields
152            .iter()
153            .map(|f| f.width() as u128 * if f.dtype == "i64" { 8 } else { 4 })
154            .sum();
155        let metadata = std::iter::once(&self.fields)
156            .chain(groups.iter().filter_map(|g| g.fields.as_ref()))
157            .map(|fields| {
158                fields
159                    .iter()
160                    .map(|f| (4096 + f.name.len() + f.from.len()) as u128)
161                    .sum::<u128>()
162            })
163            .max()
164            .unwrap_or(0);
165        let rows = groups
166            .iter()
167            .flat_map(|g| &g.files)
168            .map(|f| f.rows.unwrap_or(self.max_shard_rows))
169            .max()
170            .unwrap_or(0) as u128;
171        let batch_rows = self.stages.iter().map(|s| s.batch_size).max().unwrap_or(0) as u128;
172        let batch = (row + 128) * batch_rows + metadata;
173        let shuffle = self
174            .stages
175            .iter()
176            .filter_map(|s| s.shuffle.as_ref())
177            .map(|s| s.buffer_rows)
178            .max()
179            .unwrap_or(0) as u128;
180        let sources = self
181            .stages
182            .iter()
183            .map(|s| s.sources.len())
184            .max()
185            .unwrap_or(0) as u128;
186        let parquet = self.stages.iter().any(|s| {
187            s.sources.iter().any(|g| {
188                g.encoding
189                    .as_ref()
190                    .or(s.encoding.as_ref())
191                    .is_some_and(|e| e == "parquet")
192            })
193        });
194        let shard = row * rows;
195        // A reader's prefetch holds encoded row groups or stream windows, and
196        // the parts still in flight.
197        let fetched = crate::storage::HELD as u128
198            * if parquet {
199                (self.max_row_group_bytes as u64).max(crate::storage::WINDOW) as u128
200            } else {
201                crate::storage::WINDOW as u128
202            }
203            + crate::storage::PARTS as u128;
204        // Encoded strings and generic values can expand before prefix projection.
205        // Only active readers own this workspace; lookahead holds projected Arrow data.
206        let workspace = (64 * self.max_record_bytes as u128).max(if parquet {
207            8 * self.max_row_group_bytes as u128
208        } else {
209            0
210        }) + 16 * row * rows.min(128)
211            + 2 * shard
212            + metadata * rows.div_ceil(128)
213            + fetched
214            + 32 * 1024 * 1024;
215        let buffered = (shuffle + batch_rows + 1) * (row + 1024);
216        let snapshots = 64 * (shuffle + sources);
217        let bound = (self.threads as u128)
218            .checked_mul(self.lookahead as u128)
219            .and_then(|n| n.checked_mul(shard + metadata))
220            .and_then(|n| {
221                (self.threads as u128)
222                    .checked_mul(workspace)
223                    .and_then(|w| n.checked_add(w))
224            })
225            .and_then(|n| n.checked_add(buffered))
226            .and_then(|n| {
227                (self.prefetch_batches as u128 + 3)
228                    .checked_mul(batch * 3 + snapshots)
229                    .and_then(|q| n.checked_add(q))
230            })
231            .ok_or_else(|| anyhow::anyhow!("memory bound exceeds supported range"))?;
232        Ok(bound.try_into()?)
233    }
234
235    /// Structural checks that do not need storage. Every source must already be
236    /// resolved to files; manifest references are resolved by `manifest::resolve`.
237    pub fn validate(&self) -> Result<u64> {
238        ensure!(!self.stages.is_empty(), "no stages");
239        ensure!(
240            !self.fields.is_empty(),
241            "fields must be a nonempty allowlist"
242        );
243        ensure!(
244            self.lookahead > 0
245                && self.max_record_bytes > 0
246                && self.max_shard_rows > 0
247                && self.max_row_group_bytes > 0,
248            "invalid memory limits"
249        );
250        ensure!(
251            self.world_size > 0 && self.rank < self.world_size,
252            "invalid rank layout"
253        );
254        ensure!(self.threads > 0, "threads must be positive");
255        for (stage_index, stage) in self.stages.iter().enumerate() {
256            ensure!(
257                stage.sources.len() <= self.threads.saturating_mul(self.lookahead),
258                "threads * lookahead must hold one current shard per source"
259            );
260            ensure!(
261                stage.batch_size > 0 && !stage.sources.is_empty(),
262                "empty stage"
263            );
264            ensure!(
265                stage.shuffle.as_ref().is_none_or(|s| s.buffer_rows > 0),
266                "empty shuffle buffer"
267            );
268            let mut sum = 0.0;
269            for (source_index, group) in stage.sources.iter().enumerate() {
270                ensure!(
271                    group.manifest_uri.is_none() && group.split.is_none(),
272                    "stage {stage_index} source {source_index}: manifest source is not resolved"
273                );
274                ensure!(
275                    matches!(
276                        group
277                            .encoding
278                            .as_ref()
279                            .or(stage.encoding.as_ref())
280                            .map(String::as_str),
281                        Some("msgpack.zstf" | "jsonl.gz" | "parquet")
282                    ),
283                    "stage {stage_index} source {source_index}: unknown encoding"
284                );
285                let w = group.weight.unwrap_or(1.0);
286                ensure!(
287                    w.is_finite() && w >= 0.0 && !group.files.is_empty(),
288                    "stage {stage_index} source {source_index}: invalid source group"
289                );
290                ensure!(
291                    group
292                        .files
293                        .iter()
294                        .all(|f| f.rows.is_none_or(|n| n <= self.max_shard_rows)),
295                    "manifest rows exceed maxShardRows"
296                );
297                sum += w;
298            }
299            ensure!(sum.is_finite() && sum > 0.0, "invalid total weight");
300        }
301        for fields in std::iter::once(&self.fields).chain(
302            self.stages
303                .iter()
304                .flat_map(|s| &s.sources)
305                .filter_map(|g| g.fields.as_ref()),
306        ) {
307            let mut names = std::collections::HashSet::new();
308            for field in fields {
309                ensure!(names.insert(&field.name), "duplicate projected name");
310                ensure!(
311                    matches!(field.dtype.as_str(), "i32" | "i64" | "f32" | "bool"),
312                    "unknown dtype"
313                );
314                ensure!(
315                    field.length.is_none_or(|n| n > 0 && n <= i32::MAX as usize),
316                    "invalid field length"
317                );
318                ensure!(
319                    field.shape.is_none() || field.length.is_none(),
320                    "use length or shape, not both"
321                );
322                if let Some(shape) = &field.shape {
323                    ensure!(
324                        !shape.is_empty() && shape.iter().all(|&n| n > 0),
325                        "invalid field shape"
326                    );
327                    ensure!(
328                        shape
329                            .iter()
330                            .try_fold(1usize, |a, &b| a.checked_mul(b))
331                            .is_some_and(|n| n <= i32::MAX as usize),
332                        "field shape is too large"
333                    );
334                }
335            }
336        }
337        for (stage_index, stage) in self.stages.iter().enumerate() {
338            for (source_index, source) in stage.sources.iter().enumerate() {
339                let fields = source.fields.as_ref().unwrap_or(&self.fields);
340                ensure!(
341                    fields.len() == self.fields.len(),
342                    "stage {stage_index} source {source_index} {}: field count differs",
343                    source.files[0].uri
344                );
345                for (a, b) in fields.iter().zip(&self.fields) {
346                    ensure!(
347                        a.name == b.name && a.dtype == b.dtype && a.dimensions() == b.dimensions(),
348                        "stage {stage_index} source {source_index} {}: incompatible field {}",
349                        source.files[0].uri,
350                        b.name
351                    );
352                }
353            }
354        }
355        let bound = self.memory_bound()?;
356        let limit = self.memory_limit()?;
357        ensure!(
358            bound <= limit,
359            "memory bound {bound} bytes exceeds memoryLimitBytes {limit}"
360        );
361        Ok(bound)
362    }
363}