namelessai commited on
Commit
05c495d
Β·
verified Β·
1 Parent(s): 13e6523

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +59 -3
README.md CHANGED
@@ -1,14 +1,70 @@
1
  ---
2
  title: Ckpt2safetensors
3
- emoji: πŸ†
4
  colorFrom: red
5
  colorTo: blue
6
  sdk: gradio
7
  sdk_version: 5.9.0
8
  app_file: app.py
9
- pinned: false
10
  license: mit
11
  short_description: Checkpoint to Safetensors convertor.
12
  ---
 
13
 
14
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  title: Ckpt2safetensors
3
+ emoji: πŸš€
4
  colorFrom: red
5
  colorTo: blue
6
  sdk: gradio
7
  sdk_version: 5.9.0
8
  app_file: app.py
9
+ pinned: true
10
  license: mit
11
  short_description: Checkpoint to Safetensors convertor.
12
  ---
13
+ # CKPT to Safetensors Converter
14
 
15
+ This is a simple Gradio app that allows users to convert .ckpt (checkpoint) files to the safetensors format. It provides an easy-to-use web interface for uploading .ckpt files and converting them with a single click.
16
+
17
+ ## Features
18
+
19
+ - Web-based interface for easy file uploading
20
+ - Converts .ckpt files to safetensors format
21
+ - Handles state dictionaries stored directly or under a "state_dict" key
22
+ - Provides feedback on successful conversion or errors
23
+
24
+ ## Requirements
25
+
26
+ - Python 3.7+
27
+ - Gradio
28
+ - PyTorch
29
+ - Safetensors
30
+
31
+ ## Installation
32
+
33
+ 1. Clone this repository:
34
+ ```bash
35
+ git clone https://github.com/yourusername/ckpt-to-safetensors-converter.git
36
+ cd ckpt-to-safetensors-converter
37
+ ```
38
+
39
+ 2. Install the required dependencies:
40
+ ```bash
41
+ pip install -r requirements.txt
42
+ ```
43
+
44
+ ## Usage
45
+
46
+ 1. Run the Gradio app:
47
+ ```bash
48
+ python app.py
49
+ ```
50
+
51
+ 2. Open your web browser and go to the URL displayed in the terminal (usually `http://127.0.0.1:7860`).
52
+
53
+ 3. Upload a .ckpt file using the file upload component.
54
+
55
+ 4. The app will process the file and convert it to the safetensors format.
56
+
57
+ 5. Once complete, you'll see a success message with the name of the output file, or an error message if the conversion failed.
58
+
59
+ ## Contributing
60
+
61
+ Contributions are welcome! Please feel free to submit a Pull Request.
62
+
63
+ ## License
64
+
65
+ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
66
+
67
+ ---
68
+
69
+ Feel free to customize any part of this README as needed, including updating the repository URL and adding more specific instructions or details about your project!
70
+ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference