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| {
154                f.width() as u128
155                    * if matches!(f.dtype.as_str(), "i64" | "f64") {
156                        8
157                    } else {
158                        4
159                    }
160            })
161            .sum();
162        let metadata = std::iter::once(&self.fields)
163            .chain(groups.iter().filter_map(|g| g.fields.as_ref()))
164            .map(|fields| {
165                fields
166                    .iter()
167                    .map(|f| (4096 + f.name.len() + f.from.len()) as u128)
168                    .sum::<u128>()
169            })
170            .max()
171            .unwrap_or(0);
172        let rows = groups
173            .iter()
174            .flat_map(|g| &g.files)
175            .map(|f| f.rows.unwrap_or(self.max_shard_rows))
176            .max()
177            .unwrap_or(0) as u128;
178        let batch_rows = self.stages.iter().map(|s| s.batch_size).max().unwrap_or(0) as u128;
179        let batch = (row + 128) * batch_rows + metadata;
180        let shuffle = self
181            .stages
182            .iter()
183            .filter_map(|s| s.shuffle.as_ref())
184            .map(|s| s.buffer_rows)
185            .max()
186            .unwrap_or(0) as u128;
187        let sources = self
188            .stages
189            .iter()
190            .map(|s| s.sources.len())
191            .max()
192            .unwrap_or(0) as u128;
193        let parquet = self.stages.iter().any(|s| {
194            s.sources.iter().any(|g| {
195                g.encoding
196                    .as_ref()
197                    .or(s.encoding.as_ref())
198                    .is_some_and(|e| e == "parquet")
199            })
200        });
201        let shard = row * rows;
202        // A reader's prefetch holds encoded row groups or stream windows, and
203        // the parts still in flight.
204        let fetched = crate::storage::HELD as u128
205            * if parquet {
206                (self.max_row_group_bytes as u64).max(crate::storage::WINDOW) as u128
207            } else {
208                crate::storage::WINDOW as u128
209            }
210            + crate::storage::PARTS as u128;
211        // Encoded strings and generic values can expand before prefix projection.
212        // Only active readers own this workspace; lookahead holds projected Arrow data.
213        let workspace = (64 * self.max_record_bytes as u128).max(if parquet {
214            8 * self.max_row_group_bytes as u128
215        } else {
216            0
217        }) + 16 * row * rows.min(128)
218            + 2 * shard
219            + metadata * rows.div_ceil(128)
220            + fetched
221            + 32 * 1024 * 1024;
222        let buffered = (shuffle + batch_rows + 1) * (row + 1024);
223        let snapshots = 64 * (shuffle + sources);
224        let bound = (self.threads as u128)
225            .checked_mul(self.lookahead as u128)
226            .and_then(|n| n.checked_mul(shard + metadata))
227            .and_then(|n| {
228                (self.threads as u128)
229                    .checked_mul(workspace)
230                    .and_then(|w| n.checked_add(w))
231            })
232            .and_then(|n| n.checked_add(buffered))
233            .and_then(|n| {
234                (self.prefetch_batches as u128 + 3)
235                    .checked_mul(batch * 3 + snapshots)
236                    .and_then(|q| n.checked_add(q))
237            })
238            .ok_or_else(|| anyhow::anyhow!("memory bound exceeds supported range"))?;
239        Ok(bound.try_into()?)
240    }
241
242    /// Structural checks that do not need storage. Every source must already be
243    /// resolved to files; manifest references are resolved by `manifest::resolve`.
244    pub fn validate(&self) -> Result<u64> {
245        ensure!(!self.stages.is_empty(), "no stages");
246        ensure!(
247            !self.fields.is_empty(),
248            "fields must be a nonempty allowlist"
249        );
250        ensure!(
251            self.lookahead > 0
252                && self.max_record_bytes > 0
253                && self.max_shard_rows > 0
254                && self.max_row_group_bytes > 0,
255            "invalid memory limits"
256        );
257        ensure!(
258            self.world_size > 0 && self.rank < self.world_size,
259            "invalid rank layout"
260        );
261        ensure!(self.threads > 0, "threads must be positive");
262        for (stage_index, stage) in self.stages.iter().enumerate() {
263            ensure!(
264                stage.sources.len() <= self.threads.saturating_mul(self.lookahead),
265                "threads * lookahead must hold one current shard per source"
266            );
267            ensure!(
268                stage.batch_size > 0 && !stage.sources.is_empty(),
269                "empty stage"
270            );
271            ensure!(
272                stage.shuffle.as_ref().is_none_or(|s| s.buffer_rows > 0),
273                "empty shuffle buffer"
274            );
275            let mut sum = 0.0;
276            for (source_index, group) in stage.sources.iter().enumerate() {
277                ensure!(
278                    group.manifest_uri.is_none() && group.split.is_none(),
279                    "stage {stage_index} source {source_index}: manifest source is not resolved"
280                );
281                ensure!(
282                    matches!(
283                        group
284                            .encoding
285                            .as_ref()
286                            .or(stage.encoding.as_ref())
287                            .map(String::as_str),
288                        Some("msgpack.zstf" | "jsonl.gz" | "parquet")
289                    ),
290                    "stage {stage_index} source {source_index}: unknown encoding"
291                );
292                let w = group.weight.unwrap_or(1.0);
293                ensure!(
294                    w.is_finite() && w >= 0.0 && !group.files.is_empty(),
295                    "stage {stage_index} source {source_index}: invalid source group"
296                );
297                ensure!(
298                    group
299                        .files
300                        .iter()
301                        .all(|f| f.rows.is_none_or(|n| n <= self.max_shard_rows)),
302                    "manifest rows exceed maxShardRows"
303                );
304                sum += w;
305            }
306            ensure!(sum.is_finite() && sum > 0.0, "invalid total weight");
307        }
308        for fields in std::iter::once(&self.fields).chain(
309            self.stages
310                .iter()
311                .flat_map(|s| &s.sources)
312                .filter_map(|g| g.fields.as_ref()),
313        ) {
314            let mut names = std::collections::HashSet::new();
315            for field in fields {
316                ensure!(names.insert(&field.name), "duplicate projected name");
317                ensure!(
318                    matches!(field.dtype.as_str(), "i32" | "i64" | "f32" | "f64" | "bool"),
319                    "unknown dtype"
320                );
321                ensure!(
322                    field.length.is_none_or(|n| n > 0 && n <= i32::MAX as usize),
323                    "invalid field length"
324                );
325                ensure!(
326                    field.shape.is_none() || field.length.is_none(),
327                    "use length or shape, not both"
328                );
329                if let Some(shape) = &field.shape {
330                    ensure!(
331                        !shape.is_empty() && shape.iter().all(|&n| n > 0),
332                        "invalid field shape"
333                    );
334                    ensure!(
335                        shape
336                            .iter()
337                            .try_fold(1usize, |a, &b| a.checked_mul(b))
338                            .is_some_and(|n| n <= i32::MAX as usize),
339                        "field shape is too large"
340                    );
341                }
342            }
343        }
344        for (stage_index, stage) in self.stages.iter().enumerate() {
345            for (source_index, source) in stage.sources.iter().enumerate() {
346                let fields = source.fields.as_ref().unwrap_or(&self.fields);
347                ensure!(
348                    fields.len() == self.fields.len(),
349                    "stage {stage_index} source {source_index} {}: field count differs",
350                    source.files[0].uri
351                );
352                for (a, b) in fields.iter().zip(&self.fields) {
353                    ensure!(
354                        a.name == b.name && a.dtype == b.dtype && a.dimensions() == b.dimensions(),
355                        "stage {stage_index} source {source_index} {}: incompatible field {}",
356                        source.files[0].uri,
357                        b.name
358                    );
359                }
360            }
361        }
362        let bound = self.memory_bound()?;
363        let limit = self.memory_limit()?;
364        ensure!(
365            bound <= limit,
366            "memory bound {bound} bytes exceeds memoryLimitBytes {limit}"
367        );
368        Ok(bound)
369    }
370}