Daniel Eddie Rollins commited on
Commit
ce45a3b
·
1 Parent(s): 57d7d49

Update model card.

Browse files
Files changed (1) hide show
  1. README.md +7 -5
README.md CHANGED
@@ -34,7 +34,8 @@ The afMLevel repository includes tools for:
34
  - integrating the model into AFM anasis workflows.
35
 
36
  - **Developed by:** Maya Tekchandani
37
- - **Maintained by:** Dr Daniel E. Rollins
 
38
  - **Principal Investigator:** Dr George R. Heath
39
  - **Affiliation:** University of Leeds
40
  - **Funded by [optional]:** [More Information Needed]
@@ -47,7 +48,7 @@ The afMLevel repository includes tools for:
47
 
48
  - **Repository:** https://github.com/mayatek1/afMLevel
49
  - **Paper:** In preparation
50
- - **Demo notebooks:** https://github.com/mayatek1/afMLevel/tree/main/notebooks
51
 
52
  ## Uses
53
 
@@ -61,8 +62,8 @@ The model has been primarily tested on **biological AFM data**. It may generalis
61
 
62
  ### Downstream Use
63
 
64
- - Integration into **playNano**, enabling end‑to‑end reading and levelling.
65
- - Batch levelling of **high‑speed AFM videos** via playNano.
66
  - Preprocessing for segmentation, particle detection, or other AFM analysis tools.
67
 
68
  ### Out‑of‑Scope Use
@@ -88,7 +89,8 @@ This model is **not** intended for:
88
 
89
  ## How to Get Started with the Model
90
 
91
- Use the model through the [afMLevel](https://github.com/mayatek1/afMLevel) repository, which handles background prediction, subtraction, and output generation. Demonstration notebooks are provided in the repository.
 
92
 
93
  ## Training Details
94
 
 
34
  - integrating the model into AFM anasis workflows.
35
 
36
  - **Developed by:** Maya Tekchandani
37
+ - **Developed by:** Maya Tekchandani
38
+ - **Maintained by:** Dr Daniel E. Rollins, Dr George R. Heath
39
  - **Principal Investigator:** Dr George R. Heath
40
  - **Affiliation:** University of Leeds
41
  - **Funded by [optional]:** [More Information Needed]
 
48
 
49
  - **Repository:** https://github.com/mayatek1/afMLevel
50
  - **Paper:** In preparation
51
+ - **Demo:** [Demonstration notebooks](https://github.com/mayatek1/afMLevel/tree/main/notebooks)
52
 
53
  ## Uses
54
 
 
62
 
63
  ### Downstream Use
64
 
65
+ - Integration into [playnano](https://github.com/derollins/playNano), enabling end‑to‑end reading and levelling of **high‑speed AFM videos**,
66
+ - The `afMLevel` package works as plugin for `playnano` for easy integration,
67
  - Preprocessing for segmentation, particle detection, or other AFM analysis tools.
68
 
69
  ### Out‑of‑Scope Use
 
89
 
90
  ## How to Get Started with the Model
91
 
92
+ Use the model through the [afMLevel](https://github.com/mayatek1/afMLevel) repository, which handles background prediction, subtraction, and output generation. Demonstration notebooks are available
93
+ [within the GitHUb repository](https://github.com/mayatek1/afMLevel/tree/main/notebooks).
94
 
95
  ## Training Details
96