benke97 commited on
Commit
242c310
·
verified ·
1 Parent(s): cfdbf45

Model card: link the GitHub code repository

Browse files
Files changed (1) hide show
  1. README.md +3 -4
README.md CHANGED
@@ -10,7 +10,8 @@ library_name: pytorch
10
 
11
  # cimp-denoise weights
12
 
13
- Weights for the `denoise` command from the `cimp-denoise` package (code: CIMP-flow). It denoises STEM images by
 
14
  rendering a frame as it would look after a longer exposure. The model is a conditional flow-matching U-Net (x2x),
15
  steered by CMMP, a frozen encoder that describes an acquisition from its metadata or from the image itself.
16
 
@@ -24,12 +25,10 @@ steered by CMMP, a frozen encoder that describes an acquisition from its metadat
24
  ## Use
25
 
26
  ```
27
- pip install cimp-denoise # or: pip install -e <CIMP-flow checkout>
28
  denoise frame.emd # downloads these files to ~/.cache/cimp-denoise on first use
29
  ```
30
 
31
- While this repository is private, set `HF_TOKEN` to a token with read access before the first run.
32
-
33
  Defaults: 8 draws × 4 sampler steps, about 5 s per 512 × 512 px and 90 s per 2048 × 2048 px on a desktop GPU.
34
  Metadata mode (Velox .emd) is told min(recorded dwell, 1 µs) → 16× that. CMMP mode needs only the image.
35
 
 
10
 
11
  # cimp-denoise weights
12
 
13
+ Weights for the `denoise` command from the `cimp-denoise` package
14
+ (code: [github.com/benke97/cimp-denoise](https://github.com/benke97/cimp-denoise)). It denoises STEM images by
15
  rendering a frame as it would look after a longer exposure. The model is a conditional flow-matching U-Net (x2x),
16
  steered by CMMP, a frozen encoder that describes an acquisition from its metadata or from the image itself.
17
 
 
25
  ## Use
26
 
27
  ```
28
+ pip install git+https://github.com/benke97/cimp-denoise
29
  denoise frame.emd # downloads these files to ~/.cache/cimp-denoise on first use
30
  ```
31
 
 
 
32
  Defaults: 8 draws × 4 sampler steps, about 5 s per 512 × 512 px and 90 s per 2048 × 2048 px on a desktop GPU.
33
  Metadata mode (Velox .emd) is told min(recorded dwell, 1 µs) → 16× that. CMMP mode needs only the image.
34