liboxen 0.60.0

Oxen is a fast data version control system, built with machine learning training data in mind. Designed to handle terabytes of data with ease, using a workflow similar to git. Version both structured and unstructured data of any modality: text, images, video, audio, CSV, Parquet, JSONL, model checkpoints, and more. liboxen is the embeddable core library behind the oxen CLI and server, which power fine tuning and inference pipelines for multimodal LLMs, image models, and video models on Oxen.ai.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

use std::path::PathBuf;

use crate::constants::{DEFAULT_BRANCH_NAME, DEFAULT_REMOTE_NAME};

#[derive(Clone, Debug)]
pub struct FetchOpts {
    // The remote to fetch from
    pub remote: String,
    // The branch to clone
    pub branch: String,
    // If you only want to clone a subdirectory / tree, you can specify it here
    pub subtree_paths: Option<Vec<PathBuf>>,
    // The depth at which to clone the subtree.
    pub depth: Option<i32>,
    // If true, recursively clones the whole repository history
    // by default, only the head commit is cloned to save time and disk space
    pub all: bool,
    // Defaults to true, but on pull we want to only update the branch head if there are no conflicts
    pub should_update_branch_head: bool,
    // If true, re-scan all commits for missing version files and download them
    pub missing_files: bool,
}

impl Default for FetchOpts {
    fn default() -> Self {
        Self::new()
    }
}

impl FetchOpts {
    /// Sets `branch` to `DEFAULT_BRANCH_NAME` and defaults `all` to `false`
    pub fn new() -> FetchOpts {
        FetchOpts {
            remote: DEFAULT_REMOTE_NAME.to_string(),
            branch: DEFAULT_BRANCH_NAME.to_string(),
            subtree_paths: None,
            depth: None,
            all: false,
            should_update_branch_head: true,
            missing_files: false,
        }
    }

    pub fn from_branch(branch: impl AsRef<str>) -> FetchOpts {
        FetchOpts {
            branch: branch.as_ref().to_string(),
            ..FetchOpts::new()
        }
    }
}