panlabel 0.6.0

The universal annotation converter
Documentation 
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
51
52
53
54
55
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

use crate::error::PanlabelError;

use super::HfRepoRef;

/// Parse a user-supplied HF dataset reference (repo ID or dataset URL).
pub fn parse_hf_input(
    input: &str,
    revision: Option<&str>,
    config: Option<&str>,
    split: Option<&str>,
) -> Result<HfRepoRef, PanlabelError> {
    let (repo_id, revision_from_url) =
        if input.starts_with("http://") || input.starts_with("https://") {
            parse_repo_id_from_url(input)?
        } else {
            (validate_repo_id(input)?, None)
        };

    let merged_revision = match (revision, revision_from_url) {
        (Some(arg), Some(url_rev)) if arg != url_rev => {
            return Err(PanlabelError::HfResolveError {
                input: input.to_string(),
                message: format!(
                    "conflicting revisions: --revision='{}' but URL encodes revision='{}'",
                    arg, url_rev
                ),
            });
        }
        (Some(arg), _) => Some(arg.to_string()),
        (None, Some(url_rev)) => Some(url_rev.to_string()),
        (None, None) => None,
    };

    Ok(HfRepoRef {
        repo_id,
        revision: merged_revision,
        config: config.map(str::to_string),
        split: split.map(str::to_string),
    })
}

fn parse_repo_id_from_url(input: &str) -> Result<(String, Option<String>), PanlabelError> {
    let url = url::Url::parse(input).map_err(|source| PanlabelError::HfResolveError {
        input: input.to_string(),
        message: format!("invalid URL: {source}"),
    })?;

    let host = url
        .host_str()
        .ok_or_else(|| PanlabelError::HfResolveError {
            input: input.to_string(),
            message: "URL is missing a host".to_string(),
        })?
        .to_ascii_lowercase();

    if host != "huggingface.co" {
        return Err(PanlabelError::HfResolveError {
            input: input.to_string(),
            message: format!("expected host 'huggingface.co', found '{}'", host),
        });
    }

    let segments: Vec<&str> = url
        .path_segments()
        .map(|iter| iter.filter(|seg| !seg.is_empty()).collect())
        .unwrap_or_default();

    if segments.len() < 3 || segments[0] != "datasets" {
        return Err(PanlabelError::HfResolveError {
            input: input.to_string(),
            message:
                "expected dataset URL like https://huggingface.co/datasets/<namespace>/<dataset>"
                    .to_string(),
        });
    }

    let namespace = segments[1];
    let dataset = segments[2];
    let repo_id = validate_repo_id(&format!("{namespace}/{dataset}"))?;

    let revision = if segments.get(3) == Some(&"tree") {
        segments.get(4).map(|value| (*value).to_string())
    } else {
        None
    };

    Ok((repo_id, revision))
}

fn validate_repo_id(repo_id: &str) -> Result<String, PanlabelError> {
    let trimmed = repo_id.trim();
    let mut parts = trimmed.split('/');
    let namespace = parts.next().unwrap_or_default();
    let dataset = parts.next().unwrap_or_default();
    let extra = parts.next();

    if namespace.is_empty() || dataset.is_empty() || extra.is_some() {
        return Err(PanlabelError::HfResolveError {
            input: repo_id.to_string(),
            message: "expected repo id in '<namespace>/<dataset>' form".to_string(),
        });
    }

    Ok(trimmed.to_string())
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn parse_repo_id_input() {
        let parsed = parse_hf_input("org/dataset", None, None, Some("train")).expect("parse");
        assert_eq!(parsed.repo_id, "org/dataset");
        assert_eq!(parsed.split.as_deref(), Some("train"));
        assert_eq!(parsed.revision, None);
    }

    #[test]
    fn parse_dataset_url_input() {
        let parsed = parse_hf_input(
            "https://huggingface.co/datasets/org/dataset",
            None,
            None,
            None,
        )
        .expect("parse");
        assert_eq!(parsed.repo_id, "org/dataset");
    }

    #[test]
    fn parse_dataset_url_tree_revision() {
        let parsed = parse_hf_input(
            "https://huggingface.co/datasets/org/dataset/tree/release-v1",
            None,
            None,
            None,
        )
        .expect("parse");
        assert_eq!(parsed.repo_id, "org/dataset");
        assert_eq!(parsed.revision.as_deref(), Some("release-v1"));
    }

    #[test]
    fn revision_conflict_is_error() {
        let err = parse_hf_input(
            "https://huggingface.co/datasets/org/dataset/tree/main",
            Some("dev"),
            None,
            None,
        )
        .expect_err("should fail");

        match err {
            PanlabelError::HfResolveError { message, .. } => {
                assert!(message.contains("conflicting revisions"));
            }
            other => panic!("unexpected error: {other:?}"),
        }
    }
}