Skip to content

Commit

Permalink
Fix all cards
Browse files Browse the repository at this point in the history
  • Loading branch information
@jdeschamps
jdeschamps committed Jul 6, 2024
1 parent 557c2ab commit 3dc61d7
Show file tree
Hide file tree
Showing 4 changed files with 148 additions and 124 deletions.
96 changes: 52 additions & 44 deletions docs/algorithms/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,34 +21,38 @@ description: Descriptions of the algorithms.
<!-- N2V -->
<a class="card-wrapper" href="n2v/Noise2Void">
<div class="card">
<div class="logo">
<span class="twemoji">
--8<-- "cpu.svg"
</span>
</div>
<div class="card-content">
<h5>Noise2Void</h5>
<p>
A self-supervised denoising algorithm based on a
pixel masking scheme.
</p>
<div class="card-body">
<div class="logo">
<span class="twemoji">
--8<-- "cpu.svg"
</span>
</div>
<div class="card-content">
<h5>Noise2Void</h5>
<p>
A self-supervised denoising algorithm based on a
pixel masking scheme.
</p>
</div>
</div>
</div>
</a>
<!-- N2V2 -->
<a class="card-wrapper" href="n2v2">
<div class="card">
<div class="logo">
<span class="twemoji">
--8<-- "cpu.svg"
</span>
</div>
<div class="card-content">
<h5>N2V2</h5>
<p>
A variant of Noise2Void capable of removing
checkboard artefacts.
</p>
<div class="card-body">
<div class="logo">
<span class="twemoji">
--8<-- "cpu.svg"
</span>
</div>
<div class="card-content">
<h5>N2V2</h5>
<p>
A variant of Noise2Void capable of removing
checkboard artefacts.
</p>
</div>
</div>
</div>
</a>
Expand All @@ -57,34 +61,38 @@ description: Descriptions of the algorithms.
<!-- structN2V -->
<a class="card-wrapper" href="structn2v">
<div class="card">
<div class="logo">
<span class="twemoji">
--8<-- "cpu.svg"
</span>
</div>
<div class="card-content">
<h5>StructN2V</h5>
<p>
A variant of Noise2Void that uses an enhanced mask
to remove structured noise.
</p>
<div class="card-body">
<div class="logo">
<span class="twemoji">
--8<-- "cpu.svg"
</span>
</div>
<div class="card-content">
<h5>StructN2V</h5>
<p>
A variant of Noise2Void that uses an enhanced mask
to remove structured noise.
</p>
</div>
</div>
</div>
</a>
<!-- Noise2Noise -->
<a class="card-wrapper" href="n2n">
<div class="card">
<div class="logo">
<span class="twemoji">
--8<-- "cpu.svg"
</span>
</div>
<div class="card-content">
<h5>Noise2Noise</h5>
<p>
A supervised methods that can denoise images without
corresponding clean data.
</p>
<div class="card-body">
<div class="logo">
<span class="twemoji">
--8<-- "cpu.svg"
</span>
</div>
<div class="card-content">
<h5>Noise2Noise</h5>
<p>
A supervised methods that can denoise images without
corresponding clean data.
</p>
</div>
</div>
</div>
</a>
Expand Down
50 changes: 27 additions & 23 deletions docs/guides/careamist_api/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,35 +28,39 @@ examples.
<!-- Installation -->
<a class="card-wrapper" href="configuration">
<div class="card">
<div class="logo">
<span class="twemoji">
--8<-- "tasklist.svg"
</span>
</div>
<div class="card-content">
<h5>Configuration</h5>
<p>
The configuration is at the heart of CAREamics, it
allow users to define how and which algorithm will be
trained.
</p>
<div class="card-body">
<div class="logo">
<span class="twemoji">
--8<-- "tasklist.svg"
</span>
</div>
<div class="card-content">
<h5>Configuration</h5>
<p>
The configuration is at the heart of CAREamics, it
allow users to define how and which algorithm will be
trained.
</p>
</div>
</div>
</div>
</a>
<!-- Installation -->
<a class="card-wrapper" href="usage">
<div class="card">
<div class="logo">
<span class="twemoji">
--8<-- "code.svg"
</span>
</div>
<div class="card-content">
<h5>Using CAREAmics</h5>
<p>
The CAREamist is the core element allowing training
and prediction using the model defined in the configuration.
</p>
<div class="card-body">
<div class="logo">
<span class="twemoji">
--8<-- "code.svg"
</span>
</div>
<div class="card-content">
<h5>Using CAREAmics</h5>
<p>
The CAREamist is the core element allowing training
and prediction using the model defined in the configuration.
</p>
</div>
</div>
</div>
</a>
Expand Down
100 changes: 54 additions & 46 deletions docs/guides/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,36 +21,40 @@ We also provide a command-line interface and developer resources!
<!-- Installation -->
<a class="card-wrapper" href="careamist_api">
<div class="card">
<div class="logo">
<span class="twemoji">
--8<-- "code.svg"
</span>
</div>
<div class="card-content">
<h5>CAREamist API</h5>
<p>
The recommended way to use CAREamics in a few lines
of code to apply various methods in the most
comfortable way possible.
</p>
<div class="card-body">
<div class="logo">
<span class="twemoji">
--8<-- "code.svg"
</span>
</div>
<div class="card-content">
<h5>CAREamist API</h5>
<p>
The recommended way to use CAREamics in a few lines
of code to apply various methods in the most
comfortable way possible.
</p>
</div>
</div>
</div>
</a>
<!-- Installation -->
<a class="card-wrapper" href="lightning_api">
<div class="card">
<div class="logo">
<span class="twemoji">
--8<-- "zap.svg"
</span>
</div>
<div class="card-content">
<h5>Lightning API</h5>
<p>
Advanced users can re-use parts of CAREamics in their
Lightning pipeline, with more customization potential
available.
</p>
<div class="card-body">
<div class="logo">
<span class="twemoji">
--8<-- "zap.svg"
</span>
</div>
<div class="card-content">
<h5>Lightning API</h5>
<p>
Advanced users can re-use parts of CAREamics in their
Lightning pipeline, with more customization potential
available.
</p>
</div>
</div>
</div>
</a>
Expand All @@ -60,34 +64,38 @@ We also provide a command-line interface and developer resources!
<!-- Installation -->
<a class="card-wrapper" href="cli">
<div class="card">
<div class="logo">
<span class="twemoji">
--8<-- "terminal.svg"
</span>
</div>
<div class="card-content">
<h5>Command-line interface</h5>
<p>
Want to run CAREamics from the command line, on your
machine, remotely or on a cluster? Head this way!
</p>
<div class="card-body">
<div class="logo">
<span class="twemoji">
--8<-- "terminal.svg"
</span>
</div>
<div class="card-content">
<h5>Command-line interface</h5>
<p>
Want to run CAREamics from the command line, on your
machine, remotely or on a cluster? Head this way!
</p>
</div>
</div>
</div>
</a>
<!-- Installation -->
<a class="card-wrapper" href="dev_resources">
<div class="card">
<div class="logo">
<span class="twemoji">
--8<-- "repo.svg"
</span>
</div>
<div class="card-content">
<h5>Developer resources</h5>
<p>
More insights on how CAREamics is organized and how
to tweak it to your needs.
</p>
<div class="card-body">
<div class="logo">
<span class="twemoji">
--8<-- "repo.svg"
</span>
</div>
<div class="card-content">
<h5>Developer resources</h5>
<p>
More insights on how CAREamics is organized and how
to tweak it to your needs.
</p>
</div>
</div>
</div>
</a>
Expand Down
26 changes: 15 additions & 11 deletions scripts/gen_ref_pages.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,17 +49,21 @@ def close_row():
return "</div>\n"

def new_card(module_name):
return f"<a class=\"card-wrapper\" href=\"{module_name}\">" \
f"<div class=\"card\">\n" \
f"<div class=\"logo\">\n" \
f"<span class=\"twemoji\">" \
f"<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\" width=\"24\" height=\"24\"><path d=\"M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z\"></path></svg>" \
f"</span>" \
f"</div>" \
f"<div class=\"card-content\">" \
f"<h5>{format_name(module_name)}</h5>" \
f"</div>" \
f"</div></a>"
return (
f"<a class=\"card-wrapper\" href=\"{module_name}\">"
f"<div class=\"card\">\n"
f"<div class=\"card-body\">\n"
f"<div class=\"logo\">\n"
f"<span class=\"twemoji\">"
f"<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\" width=\"24\" height=\"24\"><path d=\"M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06Zm-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0Z\"></path></svg>"
f"</span>"
f"</div>"
f"<div class=\"card-content\">"
f"<h5>{format_name(module_name)}</h5>"
f"</div>"
f"</div>"
f"</div></a>"
)

# create mkdocs navigation
nav = mkdocs_gen_files.Nav()
Expand Down

0 comments on commit 3dc61d7

Please sign in to comment.