Support using paddle in safe_open #630

zeroRains · 2025-07-05T08:04:18Z

Support using paddle in `safe_open` API

This PR allows us to use safe_open API when set the framework='pp' or framework='paddle'. It just like the following code:

from safetensors import safe_open

tensors = {}
with safe_open(filename, framework="paddle") as f:
    for k in f.keys():
        tensors[k] = f.get_tensor(k)

In this PR, I use the latest feature(MmapStorage) in paddle. It only support for paddle >= 3.1.1 or develop version.

We also can use the original way to load tensor if the paddle version is lower than 3.1.1.

ps: MmapStorage have be merged in develop and 3.1.1.

yuanlehome

LGTM，We hope that official classmates can help review and promote code integration. Thanks!

Narsil

Looking good left a few comments.

Narsil · 2025-07-31T09:38:45Z

bindings/python/src/lib.rs

+            "paddle" => Ok(Framework::Paddle),
+            "paddlepaddle" => Ok(Framework::Paddle),
+            "pp" => Ok(Framework::Paddle),


Can we remove paddlepaddle (I don't see any reference anywhere in the tutorials).

Same for pp unless I missed it as something being regularly used.

We can remove paddlepaddle. But we should save pp. pp in paddle just like pt in pytorch and np in numpy.

I also use pp in test case file. Do you mean that the abbreviation is not required?

I meant, can you point me to places where the abbreviation is used "naturally". Something like tutorials, examples docs from the official paddlepaddle project (or some big user of it).

For numpy (np): https://numpy.org/doc/stable/user/absolute_beginners.html
For pytorch: https://huggingface.co/docs/transformers/main_classes/tokenizer#transformers.PreTrainedTokenizerFast.__call__.return_tensors It's a convention used in a few key places in HF's ecosystem hence why I went with it (despite my preference for having only 1 clear name for things).

Right, it seems no need to save pp, I will remove it later.

Narsil · 2025-07-31T09:40:23Z

bindings/python/src/lib.rs

+                let version = Version::from_string(&version).map_err(SafetensorError::new_err)?;
+
+                // todo: version check, only paddle 3.1 or develop
+                if version >= Version::new(3, 1, 0) || version >= Version::new(0, 0, 0) {


Can you remove version 0.0.0 ?

Version 0.0.0 means user uses the develop version. The latest develop version have supported this function. Maybe I should use == but not >=.

Then yes == is preferred, otherwise afaik users for versions > 0.0.0 < 3.1.0 will encounter issues, right ?

Yes, this feature only support for paddle>=3.1.1 and develop version(0.0.0). It should use the Mmap of safetensors for versions > 0.0.0 < 3.1.1.

Narsil · 2025-07-31T09:41:37Z

bindings/python/src/lib.rs

+                    if cur_type == Dtype::U16 {
+                        // paddle set bf16 as u16
+                        cur_type = Dtype::BF16;
+                    }


info is the source in the safetensors file, I think this is reversed logic.

Try to use non mutable variables. let cur_type = if info.dtype == xxx{ something } else{ something else};

Make it much easier to be sure no one if modifying this later on.

Ok, I will modify it.

Narsil · 2025-07-31T09:45:28Z

bindings/python/tests/test_paddle_comparison.py

@@ -1,7 +1,10 @@
+import threading


Remove this import.

Narsil · 2025-07-31T09:46:21Z

bindings/python/tests/test_paddle_comparison.py

+            "a": A,
+        }
+        ident = threading.get_ident()
+        save_file(tensors, f"./tensor_{ident}.safetensors")


Just use a unique name, no need to use ident.

Narsil · 2025-07-31T09:46:48Z

bindings/python/src/lib.rs

 enum Device {
    Cpu,
    Cuda(usize),
+    Gpu(usize),


No, it's called CUDA, let's not add something new. Let's reuse cuda(usize). If paddle uses a different name, let's just make sure the conversion happen correctly when they are called (so in paddle only code).

ok, I will remove it.

Re-reading this I have question about GPU semantics with paddle, how does it deal with non cuda GPUs ?

Sorry, I misunderstood your question. The gpu in paddle refers to the cuda GPU, and other non cuda GPUs are represented by xxx_gpu(like intel_gpu/metax_gpu). This repo will show more ways to access hardware. https://github.com/PaddlePaddle/PaddleCustomDevice

@Narsil

bindings/python/src/lib.rs

zeroRains · 2025-08-01T07:06:08Z

I have modified the code following the comments. Could you review it again? Thanks! @Narsil

Narsil · 2025-08-15T08:48:23Z

Since https://github.com/huggingface/safetensors/pull/646/commits is open, maybe we should close this ? It seems the overlap is significant here, right ?

zeroRains · 2025-08-15T09:13:44Z

Since https://github.com/huggingface/safetensors/pull/646/commits is open, maybe we should close this ? It seems the overlap is significant here, right ?

No, this PR #646 still has some content that needs to be modified, but the safe_open function is relatively complete. We hope to use the safe_open function as soon as possible, so we hope to merge the current PR first, and then synchronize PR #646 from the main branch. @Narsil

Narsil · 2025-08-15T15:12:03Z

Well my comments from here still apply. This PR is breaking paddle <3.1.1

zeroRains · 2025-08-16T08:11:46Z

Well my comments from here still apply. This PR is breaking paddle <3.1.1

OK, I am install the paddlepaddle == 3.0.0. I run the test file test_paddle_comparison.py. I got this error.

I should handle the device when I use cuda:x, now it has solved.

Is there any other testing case which will trigger the breaking when paddle < 3.1.1 ?

Narsil

LGTM.

bindings/python/src/lib.rs

Narsil · 2025-08-18T10:36:45Z

We can remove the Storage suffix for both variants to make clippy happy.

Narsil · 2025-08-18T10:37:06Z

Actually let me merge it. This is not important.

support using paddle in with_open

5192ab0

yuanlehome approved these changes Jul 7, 2025

View reviewed changes

zeroRains mentioned this pull request Jul 7, 2025

Support use safetensors with paddle.MmapStorage to load model files PaddlePaddle/FastDeploy#2730

Open

2 tasks

Narsil reviewed Jul 31, 2025

View reviewed changes

zeroRains added 2 commits August 1, 2025 14:49

update implementation and add device test case

87ed10a

update version requirement

5f0c158

zeroRains added 2 commits August 4, 2025 10:02

add link

606962a

remove the name of pp

d13b978

changeyoung98 mentioned this pull request Aug 11, 2025

Support paddle save/load/save_file/load_file without coverting to numpy #646

Merged

remove pp

fb20642

fix the bug in Mmap when paddle < 3.1.1

1e685a7

Narsil approved these changes Aug 18, 2025

View reviewed changes

bindings/python/src/lib.rs Show resolved Hide resolved

Narsil merged commit a56b49f into huggingface:main Aug 18, 2025
20 of 29 checks passed

zeroRains deleted the pp branch August 18, 2025 13:48

Support using paddle in safe_open #630

Support using paddle in safe_open #630

Uh oh!

Conversation

zeroRains commented Jul 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Support using paddle in safe_open API

Uh oh!

yuanlehome left a comment

Choose a reason for hiding this comment

Uh oh!

Narsil left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zeroRains Aug 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zeroRains Aug 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

zeroRains commented Aug 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Narsil commented Aug 15, 2025

Uh oh!

zeroRains commented Aug 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Narsil commented Aug 15, 2025

Uh oh!

zeroRains commented Aug 16, 2025

Uh oh!

Narsil left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Narsil commented Aug 18, 2025

Uh oh!

Narsil commented Aug 18, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

zeroRains commented Jul 5, 2025 •

edited

Loading

Support using paddle in `safe_open` API

zeroRains Aug 4, 2025 •

edited

Loading

zeroRains Aug 4, 2025 •

edited

Loading

zeroRains commented Aug 1, 2025 •

edited

Loading

zeroRains commented Aug 15, 2025 •

edited

Loading