Skip to content

Commit

Permalink
Fix paths
Browse files Browse the repository at this point in the history
  • Loading branch information
jdeschamps committed Nov 8, 2024
1 parent 97e5ef6 commit 67c7722
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ to create configurations with a only few parameters related to the algorithm use
want to train.

All convenience methods can be found in the `careamics.config` modules. CAREamics
currently supports [Noise2Void](../../algorithms/n2v/index.md) and its variants,
[CARE](../../algorithms/care/index.md) and [Noise2Noise](../../algorithms/n2n/index.md).
currently supports [Noise2Void](../../../algorithms/Noise2Void) and its variants,
[CARE](../../../algorithms/CARE) and [Noise2Noise](../../../algorithms/Noise2Noise).

``` python title="Import convenience functions"
--8<-- "careamics-examples/guides/careamist_api/configuration/convenience_functions.py:imports"
Expand Down Expand Up @@ -278,7 +278,7 @@ variants [N2V2](../../../algorithms/n2v2/) and [structN2V](../../../algorithms/s
!!! note "Understanding Noise2Void and its variants"

Before deciding which variant to use, and how to modify the parameters, we recommend
to die a little a bit on [how each algorithm works](../../algorithms/index.md)!
to die a little a bit on [how each algorithm works](../../../algorithms/index.md)!


### Noise2Void parameters
Expand Down Expand Up @@ -325,7 +325,7 @@ StructN2V has two parameters that can be set:

### Using another loss function

As opposed to Noise2Void, [CARE](../../../algorithms/care/) and [Noise2Noise](../../../algorithms/n2n)
As opposed to Noise2Void, [CARE](../../../algorithms/CARE) and [Noise2Noise](../../../algorithms/Noise2Noise)
can be trained with different loss functions. This can be set using the `loss` parameter
(surprise, surprise!).

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/careamist_api/usage/datasets.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ into the network. CAREamics supports the following transforms (see


The `Normalize` transform is always applied, and the rest are optional. The exception is
`N2VManipulateModel`, which is only applied when training with N2V (see [Noise2Void](../../../algorithms/n2v/index.md)).
`N2VManipulateModel`, which is only applied when training with N2V (see [Noise2Void](../../../algorithms/Noise2Void)).

!!! note "When to turn off transforms?"

Expand Down
Empty file removed docs/guides/dev_resources/CI.md
Empty file.
Empty file.
Empty file.
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ nav:
- napari plugins:
- guides/napari_plugin/index.md
- Tutorials:
- guides/turotials/index.md
- guides/tutorials/index.md
- Lightning API:
- guides/lightning_api/index.md
- guides/lightning_api/lightning_module.md
Expand Down
13 changes: 10 additions & 3 deletions scripts/gen_jupyter_nav.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,18 @@ def bottom_text() -> str:
"[the guide](../../guides/dev_resources/website.md#jupyter-notebook-applications)."
)

def open_section(title: str) -> str:
def open_section(title: str, skip_algo: bool = False) -> str:
"""Open the tags of a new card grid section."""

if skip_algo:
algo = ""
else:
algo = f"For more details on the algorithm, check out its [description](../../algorithms/{title}).\n\n"


return (
f"# {title}\n\n"
f"For more details on the algorithm, check out its [description](../../algorithms/{title.lower()}).\n\n"
f"{algo}"
f"<div class=\"md-container secondary-section\">\n"
f" <div class=\"g\">\n"
f" <div class=\"section\">\n"
Expand Down Expand Up @@ -217,7 +224,7 @@ class Card:
with mkdocs_gen_files.open(index_file, "a") as index_md:

# open section
index_md.write(open_section(cat))
index_md.write(open_section(cat, skip_algo = cat == "Lightning_API"))

# write rows
count = 0
Expand Down

0 comments on commit 67c7722

Please sign in to comment.