From 55bb50935654690aec8291d02d72c2f063a3cc01 Mon Sep 17 00:00:00 2001 From: Mikel Izeta Date: Tue, 27 May 2025 19:39:55 +0200 Subject: [PATCH 1/4] Update README.md w/ cache dir information --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index c6032e1..3f02200 100644 --- a/README.md +++ b/README.md @@ -78,6 +78,9 @@ If trying to use an `10.X` CUDA runtime you may have to install older versions o `torch` and `pytorch-lightning`, see [teamtomo/fidder#17](https://github.com/teamtomo/fidder/issues/17) for details. +### Model weights cache directory +Fidder will fetch the needed weights from Zenodo on its first run. To do so, [pooch](https://www.fatiando.org/pooch/latest/index.html) is used to download the weights to your computer. In Unix-like systems, this will [default](https://www.fatiando.org/pooch/latest/api/generated/pooch.os_cache.html#pooch-os-cache) to _~/.cache/fidder_ unless XDG_CACHE_HOME is set to a different location. + ## Notes This package provides similar functionality to From 48752e2d5eb4c4d20ff6172107f9ddd2259e8ecf Mon Sep 17 00:00:00 2001 From: Mikel Izeta Date: Tue, 27 May 2025 19:42:45 +0200 Subject: [PATCH 2/4] Update index.md w/ cache dir information --- docs/index.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 352276d..c8a8773 100644 --- a/docs/index.md +++ b/docs/index.md @@ -84,7 +84,10 @@ pip install fidder If trying to use an `10.X` CUDA runtime you may have to install older versions of `torch` and `pytorch-lightning`, see -[teamtomo/fidder#17](https://github.com/teamtomo/fidder/issues/17) for details. +[teamtomo/fidder#17](https://github.com/teamtomo/fidder/issues/17) for details + +### Model weights cache directory +Fidder will fetch the needed weights from Zenodo on its first run. To do so, [pooch](https://www.fatiando.org/pooch/latest/index.html) is used to download the weights to your computer. In Unix-like systems, this will [default](https://www.fatiando.org/pooch/latest/api/generated/pooch.os_cache.html#pooch-os-cache) to _~/.cache/fidder_ unless XDG_CACHE_HOME is set to a different location. # Notes From 8f287e0a86205a5443657cd8b407b46a0c171930 Mon Sep 17 00:00:00 2001 From: Mikel Izeta Date: Tue, 27 May 2025 19:49:28 +0200 Subject: [PATCH 3/4] Update index.md, recover accidentaly deleted character --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index c8a8773..3b5fc16 100644 --- a/docs/index.md +++ b/docs/index.md @@ -84,7 +84,7 @@ pip install fidder If trying to use an `10.X` CUDA runtime you may have to install older versions of `torch` and `pytorch-lightning`, see -[teamtomo/fidder#17](https://github.com/teamtomo/fidder/issues/17) for details +[teamtomo/fidder#17](https://github.com/teamtomo/fidder/issues/17) for details. ### Model weights cache directory Fidder will fetch the needed weights from Zenodo on its first run. To do so, [pooch](https://www.fatiando.org/pooch/latest/index.html) is used to download the weights to your computer. In Unix-like systems, this will [default](https://www.fatiando.org/pooch/latest/api/generated/pooch.os_cache.html#pooch-os-cache) to _~/.cache/fidder_ unless XDG_CACHE_HOME is set to a different location. From 70239c6b7236798e1f0b313f3e6b56fa15c0770f Mon Sep 17 00:00:00 2001 From: Mikel Izeta Date: Tue, 27 May 2025 20:00:37 +0200 Subject: [PATCH 4/4] Update index.md to fix header level In README.md it's ### but in the MkDocs it should be ## to keep it consistent level-wise --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 3b5fc16..7346d81 100644 --- a/docs/index.md +++ b/docs/index.md @@ -86,7 +86,7 @@ If trying to use an `10.X` CUDA runtime you may have to install older versions o `torch` and `pytorch-lightning`, see [teamtomo/fidder#17](https://github.com/teamtomo/fidder/issues/17) for details. -### Model weights cache directory +## Model weights cache directory Fidder will fetch the needed weights from Zenodo on its first run. To do so, [pooch](https://www.fatiando.org/pooch/latest/index.html) is used to download the weights to your computer. In Unix-like systems, this will [default](https://www.fatiando.org/pooch/latest/api/generated/pooch.os_cache.html#pooch-os-cache) to _~/.cache/fidder_ unless XDG_CACHE_HOME is set to a different location. # Notes