opendal/services/huggingface/
backend.rs

1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements.  See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership.  The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License.  You may obtain a copy of the License at
8//
9//   http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied.  See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18use std::sync::Arc;
19
20use bytes::Buf;
21use http::Response;
22use http::StatusCode;
23use log::debug;
24
25use super::HUGGINGFACE_SCHEME;
26use super::config::HuggingfaceConfig;
27use super::core::HuggingfaceCore;
28use super::core::HuggingfaceStatus;
29use super::error::parse_error;
30use super::lister::HuggingfaceLister;
31use crate::raw::*;
32use crate::*;
33
34/// [Huggingface](https://huggingface.co/docs/huggingface_hub/package_reference/hf_api)'s API support.
35#[doc = include_str!("docs.md")]
36#[derive(Debug, Default)]
37pub struct HuggingfaceBuilder {
38    pub(super) config: HuggingfaceConfig,
39}
40
41impl HuggingfaceBuilder {
42    /// Set repo type of this backend. Default is model.
43    ///
44    /// Available values:
45    /// - model
46    /// - dataset
47    ///
48    /// Currently, only models and datasets are supported.
49    /// [Reference](https://huggingface.co/docs/hub/repositories)
50    pub fn repo_type(mut self, repo_type: &str) -> Self {
51        if !repo_type.is_empty() {
52            self.config.repo_type = Some(repo_type.to_string());
53        }
54        self
55    }
56
57    /// Set repo id of this backend. This is required.
58    ///
59    /// Repo id consists of the account name and the repository name.
60    ///
61    /// For example, model's repo id looks like:
62    /// - meta-llama/Llama-2-7b
63    ///
64    /// Dataset's repo id looks like:
65    /// - databricks/databricks-dolly-15k
66    pub fn repo_id(mut self, repo_id: &str) -> Self {
67        if !repo_id.is_empty() {
68            self.config.repo_id = Some(repo_id.to_string());
69        }
70        self
71    }
72
73    /// Set revision of this backend. Default is main.
74    ///
75    /// Revision can be a branch name or a commit hash.
76    ///
77    /// For example, revision can be:
78    /// - main
79    /// - 1d0c4eb
80    pub fn revision(mut self, revision: &str) -> Self {
81        if !revision.is_empty() {
82            self.config.revision = Some(revision.to_string());
83        }
84        self
85    }
86
87    /// Set root of this backend.
88    ///
89    /// All operations will happen under this root.
90    pub fn root(mut self, root: &str) -> Self {
91        self.config.root = if root.is_empty() {
92            None
93        } else {
94            Some(root.to_string())
95        };
96
97        self
98    }
99
100    /// Set the token of this backend.
101    ///
102    /// This is optional.
103    pub fn token(mut self, token: &str) -> Self {
104        if !token.is_empty() {
105            self.config.token = Some(token.to_string());
106        }
107        self
108    }
109
110    /// configure the Hub base url. You might want to set this variable if your
111    /// organization is using a Private Hub https://huggingface.co/enterprise
112    ///
113    /// Default is "https://huggingface.co"
114    pub fn endpoint(mut self, endpoint: &str) -> Self {
115        if !endpoint.is_empty() {
116            self.config.endpoint = Some(endpoint.to_string());
117        }
118        self
119    }
120}
121
122impl Builder for HuggingfaceBuilder {
123    type Config = HuggingfaceConfig;
124
125    /// Build a HuggingfaceBackend.
126    fn build(self) -> Result<impl Access> {
127        debug!("backend build started: {:?}", &self);
128
129        let repo_type = match self.config.repo_type.as_deref() {
130            Some("model") => Ok(RepoType::Model),
131            Some("dataset") => Ok(RepoType::Dataset),
132            Some("space") => Err(Error::new(
133                ErrorKind::ConfigInvalid,
134                "repo type \"space\" is unsupported",
135            )),
136            Some(repo_type) => Err(Error::new(
137                ErrorKind::ConfigInvalid,
138                format!("unknown repo_type: {repo_type}").as_str(),
139            )
140            .with_operation("Builder::build")
141            .with_context("service", HUGGINGFACE_SCHEME)),
142            None => Ok(RepoType::Model),
143        }?;
144        debug!("backend use repo_type: {:?}", &repo_type);
145
146        let repo_id = match &self.config.repo_id {
147            Some(repo_id) => Ok(repo_id.clone()),
148            None => Err(Error::new(ErrorKind::ConfigInvalid, "repo_id is empty")
149                .with_operation("Builder::build")
150                .with_context("service", HUGGINGFACE_SCHEME)),
151        }?;
152        debug!("backend use repo_id: {}", &repo_id);
153
154        let revision = match &self.config.revision {
155            Some(revision) => revision.clone(),
156            None => "main".to_string(),
157        };
158        debug!("backend use revision: {}", &revision);
159
160        let root = normalize_root(&self.config.root.unwrap_or_default());
161        debug!("backend use root: {}", &root);
162
163        let token = self.config.token.as_ref().cloned();
164
165        let endpoint = match &self.config.endpoint {
166            Some(endpoint) => endpoint.clone(),
167            None => {
168                // Try to read from HF_ENDPOINT env var which is used
169                // by the official huggingface clients.
170                if let Ok(env_endpoint) = std::env::var("HF_ENDPOINT") {
171                    env_endpoint
172                } else {
173                    "https://huggingface.co".to_string()
174                }
175            }
176        };
177        debug!("backend use endpoint: {}", &endpoint);
178
179        Ok(HuggingfaceBackend {
180            core: Arc::new(HuggingfaceCore {
181                info: {
182                    let am = AccessorInfo::default();
183                    am.set_scheme(HUGGINGFACE_SCHEME)
184                        .set_native_capability(Capability {
185                            stat: true,
186                            read: true,
187                            list: true,
188                            list_with_recursive: true,
189                            shared: true,
190                            ..Default::default()
191                        });
192                    am.into()
193                },
194                repo_type,
195                repo_id,
196                revision,
197                root,
198                token,
199                endpoint,
200            }),
201        })
202    }
203}
204
205/// Backend for Huggingface service
206#[derive(Debug, Clone)]
207pub struct HuggingfaceBackend {
208    core: Arc<HuggingfaceCore>,
209}
210
211impl Access for HuggingfaceBackend {
212    type Reader = HttpBody;
213    type Writer = ();
214    type Lister = oio::PageLister<HuggingfaceLister>;
215    type Deleter = ();
216
217    fn info(&self) -> Arc<AccessorInfo> {
218        self.core.info.clone()
219    }
220
221    async fn stat(&self, path: &str, _: OpStat) -> Result<RpStat> {
222        // Stat root always returns a DIR.
223        if path == "/" {
224            return Ok(RpStat::new(Metadata::new(EntryMode::DIR)));
225        }
226
227        let resp = self.core.hf_path_info(path).await?;
228
229        let status = resp.status();
230
231        match status {
232            StatusCode::OK => {
233                let mut meta = parse_into_metadata(path, resp.headers())?;
234                let bs = resp.into_body();
235
236                let decoded_response: Vec<HuggingfaceStatus> =
237                    serde_json::from_reader(bs.reader()).map_err(new_json_deserialize_error)?;
238
239                // NOTE: if the file is not found, the server will return 200 with an empty array
240                if let Some(status) = decoded_response.first() {
241                    if let Some(commit_info) = status.last_commit.as_ref() {
242                        meta.set_last_modified(commit_info.date.parse::<Timestamp>()?);
243                    }
244
245                    meta.set_content_length(status.size);
246
247                    match status.type_.as_str() {
248                        "directory" => meta.set_mode(EntryMode::DIR),
249                        "file" => meta.set_mode(EntryMode::FILE),
250                        _ => return Err(Error::new(ErrorKind::Unexpected, "unknown status type")),
251                    };
252                } else {
253                    return Err(Error::new(ErrorKind::NotFound, "path not found"));
254                }
255
256                Ok(RpStat::new(meta))
257            }
258            _ => Err(parse_error(resp)),
259        }
260    }
261
262    async fn read(&self, path: &str, args: OpRead) -> Result<(RpRead, Self::Reader)> {
263        let resp = self.core.hf_resolve(path, args.range(), &args).await?;
264
265        let status = resp.status();
266
267        match status {
268            StatusCode::OK | StatusCode::PARTIAL_CONTENT => {
269                Ok((RpRead::default(), resp.into_body()))
270            }
271            _ => {
272                let (part, mut body) = resp.into_parts();
273                let buf = body.to_buffer().await?;
274                Err(parse_error(Response::from_parts(part, buf)))
275            }
276        }
277    }
278
279    async fn list(&self, path: &str, args: OpList) -> Result<(RpList, Self::Lister)> {
280        let l = HuggingfaceLister::new(self.core.clone(), path.to_string(), args.recursive());
281
282        Ok((RpList::default(), oio::PageLister::new(l)))
283    }
284}
285
286/// Repository type of Huggingface. Currently, we only support `model` and `dataset`.
287/// [Reference](https://huggingface.co/docs/hub/repositories)
288#[derive(Debug, Clone, Copy)]
289pub enum RepoType {
290    Model,
291    Dataset,
292}
opendal/services/huggingface/backend.rs

opendal/services/huggingface/
backend.rs
