han-xudong commited on
Commit
be4e832
·
verified ·
1 Parent(s): d0e8c36

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +89 -89
README.md CHANGED
@@ -1,89 +1,89 @@
1
- ---
2
- license: bsd-3-clause
3
- pipeline_tag: robotics
4
- tags:
5
- - necknet
6
- - prosoro
7
- - omnineck
8
- - multimodal
9
- - onnx
10
- - pytorch
11
- library_name: transformers
12
- datasets:
13
- - han-xudong/prosoro-100k
14
- ---
15
-
16
- # Model Card for NeckNet
17
-
18
- ## Table of Contents
19
-
20
- - [Model Card for NeckNet](#model-card-for-necknet)
21
- - [Table of Contents](#table-of-contents)
22
- - [Model Description](#model-description)
23
- - [Intended Use](#intended-use)
24
- - [Training Data](#training-data)
25
- - [Citation](#citation)
26
-
27
- ## Model Description
28
-
29
- NeckNet is an MLP model designed for the OmniNeck. It can predict both 6D force and 3D shape (mesh nodes) from the 6D motion of the ball.
30
-
31
- Try it out on the [Spaces demo](https://huggingface.co/spaces/han-xudong/necknet-demo).
32
-
33
- - Developer: Xudong Han, Tianyu Wu, Fang Wan, and Chaoyang Song.
34
- - Model type: MLP
35
- - License: BSD-3-Clause
36
-
37
- ## Intended Use
38
-
39
- This model is intended for researchers and developers working in robotics and tactile sensing. It can be used to enhance the capabilities of robotic systems by providing accurate predictions of force and shape based on tactile data.
40
-
41
- To load the model:
42
-
43
- ```python
44
- from transformers import AutoModel
45
-
46
- model = AutoModel.from_pretrained("han-xudong/necknet", trust_remote_code=True)
47
- x = torch.zeros((1, 6)) # Example input: batch size of 1, 6D motion
48
- output = model(x)
49
- ```
50
-
51
- Or to load the ONNX version:
52
-
53
- ```python
54
- # Example code to load onnx
55
- import onnxruntime as ort
56
- import numpy as np
57
- from huggingface_hub import hf_hub_download
58
-
59
- onnx_model_path = hf_hub_download("han-xudong/necknet", filename="model.onnx")
60
- ort_session = ort.InferenceSession(onnx_model_path)
61
-
62
- # Example input
63
- x = np.zeros((1, 6), dtype=np.float32) # Batch size of 1, 6D motion
64
- output = ort_session.run(None, {"motion": x})
65
- ```
66
-
67
- ## Training Data
68
-
69
- The model was trained on the [NeckNet-100K](https://huggingface.co/datasets/han-xudong/necknet-100k) dataset, which includes a variety of motion, force, and shape data collected by finite element simulations.
70
-
71
- ## Citation
72
-
73
- If you use this model in your research, please cite the following papers:
74
-
75
- ```bibtex
76
- @article{liu2024proprioceptive,
77
- title={Proprioceptive learning with soft polyhedral networks},
78
- author={Liu, Xiaobo and Han, Xudong and Hong, Wei and Wan, Fang and Song, Chaoyang},
79
- journal={The International Journal of Robotics Research},
80
- volume = {43},
81
- number = {12},
82
- pages = {1916-1935},
83
- year = {2024},
84
- publisher={SAGE Publications Sage UK: London, England},
85
- doi = {10.1177/02783649241238765}
86
- }
87
- ```
88
-
89
- [](https://arxiv.org/abs/2308.08538)
 
1
+ ---
2
+ license: bsd-3-clause
3
+ pipeline_tag: robotics
4
+ tags:
5
+ - necknet
6
+ - prosoro
7
+ - omnineck
8
+ - multimodal
9
+ - onnx
10
+ - pytorch
11
+ library_name: transformers
12
+ datasets:
13
+ - han-xudong/prosoro-100k
14
+ ---
15
+
16
+ <p align="center">
17
+ <img src="https://cdn-uploads.huggingface.co/production/uploads/670336f25ce58dd0c33e32e3/EC3s3yVe3mLlq6t6QxQGL.jpeg"
18
+ style="width:100%; max-width:1000px; height:auto;">
19
+ </p>
20
+
21
+
22
+ ![banner](https://cdn-uploads.huggingface.co/production/uploads/670336f25ce58dd0c33e32e3/UC5ubSs7dBMU_y4YwUOMZ.jpeg)
23
+
24
+ # NeckNet
25
+
26
+ ## Model Description
27
+
28
+ NeckNet is an MLP model designed for the OmniNeck. It can predict both 6D force and 3D shape (mesh nodes) from the 6D motion of the ball.
29
+
30
+ Try it out on the [Spaces demo](https://huggingface.co/spaces/han-xudong/necknet-demo).
31
+
32
+ - Developer: Xudong Han, Fang Wan, and Chaoyang Song.
33
+ - Model type: MLP
34
+ - License: BSD-3-Clause
35
+ - Github: [https://github.com/han-xudong/necknet](https://github.com/han-xudong/necknet)
36
+
37
+ ## Intended Use
38
+
39
+ This model is intended for researchers and developers working in robotics and tactile sensing. It can be used to enhance the capabilities of robotic systems by providing accurate predictions of force and shape based on tactile data.
40
+
41
+ To load the model:
42
+
43
+ ```python
44
+ from transformers import AutoModel
45
+
46
+ model = AutoModel.from_pretrained("han-xudong/necknet", trust_remote_code=True)
47
+ x = torch.zeros((1, 6)) # Example input: batch size of 1, 6D motion
48
+ output = model(x)
49
+ ```
50
+
51
+ Or to load the ONNX version:
52
+
53
+ ```python
54
+ # Example code to load onnx
55
+ import onnxruntime as ort
56
+ import numpy as np
57
+ from huggingface_hub import hf_hub_download
58
+
59
+ onnx_model_path = hf_hub_download("han-xudong/necknet", filename="model.onnx")
60
+ ort_session = ort.InferenceSession(onnx_model_path)
61
+
62
+ # Example input
63
+ x = np.zeros((1, 6), dtype=np.float32) # Batch size of 1, 6D motion
64
+ output = ort_session.run(None, {"motion": x})
65
+ ```
66
+
67
+ ## Training Data
68
+
69
+ The model was trained on the [ProSoRo-100K](https://huggingface.co/datasets/han-xudong/prosoro-100k) dataset, which includes a variety of motion, force, and shape data collected by finite element simulations.
70
+
71
+ ## Citation
72
+
73
+ If you use this model in your research, please cite the following papers:
74
+
75
+ ```bibtex
76
+ @article{liu2024proprioceptive,
77
+ title={Proprioceptive learning with soft polyhedral networks},
78
+ author={Liu, Xiaobo and Han, Xudong and Hong, Wei and Wan, Fang and Song, Chaoyang},
79
+ journal={The International Journal of Robotics Research},
80
+ volume = {43},
81
+ number = {12},
82
+ pages = {1916-1935},
83
+ year = {2024},
84
+ publisher={SAGE Publications Sage UK: London, England},
85
+ doi = {10.1177/02783649241238765}
86
+ }
87
+ ```
88
+
89
+ [](https://arxiv.org/abs/2308.08538)