Skip to content

Commit e4ab9df

Browse files
authored
Merge pull request #95 from qupath/0.5
0.5
2 parents ca29b14 + 62a0cb0 commit e4ab9df

File tree

4 files changed

+10
-13
lines changed

4 files changed

+10
-13
lines changed

docs/deep/gpu.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ This is **only** relevant if you're using Windows or Linux with an NVIDA GPU.
1414

1515
:::{admonition} What about Macs?
1616
NVIDIA GPUs are extremely uncommon in Macs (I had one in a 2013 iMac... but no more).
17-
More recent Macs with Apple Silicon *do* have GPU acceleration, but it is quite different.
17+
More recent Macs with Apple silicon *do* have GPU acceleration, but it is quite different.
1818

19-
Currently, Apple Silicon GPU acceleration *can* work with PyTorch via Deep Java Library.
19+
Currently, Apple silicon GPU acceleration *can* work with PyTorch via Deep Java Library.
2020
Not all models work, but I have used it very successfully with [wsinfer.md](wsinfer-extension) and seen a substantial improvement in performance.
2121

2222
The good news is that it requires *none of the awkward configuration here*.
@@ -95,7 +95,7 @@ The following sections attempt to outline the versions (as best I can figure the
9595
| v0.5.x | 0.24.0 | 2.10.1 | 11.3 |
9696
| v0.4.x | 0.20.0 | 2.7.4 | 11.2 |
9797

98-
> Note: DJL + TensorFlow will currently not work **at all** on Apple Silicon (no matter whether you have the Intel or Apple Silicon build of QuPath... unless you build TensorFlow from source).
98+
> Note: DJL + TensorFlow will currently not work **at all** on Apple silicon (no matter whether you have the Intel or Apple silicon build of QuPath... unless you build TensorFlow from source).
9999
100100

101101
## Conda environments

docs/deep/wsinfer.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ If you use WSInfer and/or this extension in a publication, please make sure to c
1919

2020
:::{tip}
2121
A GPU is not required but can dramatically speed up processing.
22-
If you have an NVIDIA GPU and want to use it with WSInfer, you will need to install a version of CUDA compatible with PyTorch - please see [the Deep Java Library page](deep-java-library-gpu).
22+
If you have an NVIDIA GPU and want to use it with WSInfer, you will need to install a version of CUDA compatible with PyTorch - please see {doc}`gpu`.
2323
:::
2424

2525

@@ -103,12 +103,12 @@ However the most (potentially) exciting additional option is the {guilabel}`Pref
103103
The options available will depend upon your computer's capabilities (at least as far as they could be discerned by Deep Java Library):
104104

105105
* **CPU**: This is generally the safest - and slowest - option, because it should be supported on all computers.
106-
* **MPS**: This stands for *Metal Performance Shaders*, and should be available on recent Apple Silicon - it is the Mac version of GPU acceleration
106+
* **MPS**: This stands for *Metal Performance Shaders*, and should be available on recent Apple silicon - it is the Mac version of GPU acceleration
107107
* **GPU**: This should appear if you have an NVIDIA GPU, CUDA... and a little bit of luck.
108108

109109
If either MPS or GPU work for you, they should reduce the time required for inference by a *lot*.
110110
However configuration for GPU can be tricky, as it will depend upon other hardware and software on your computer - CUDA in particular.
111-
For more info, see [the Deep Java Library page](deep-java-library-gpu).
111+
For more info, see {doc}`gpu`.
112112

113113
:::{admonition} PyTorch & CUDA versions
114114
:class: tip

docs/intro/formats.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,9 @@ Bio-Formats supports most images that can be read by OpenSlide, but not all - an
2828
However, file formats are tricky and tend to have lots of variants. Just because a format is listed as being supported by Bio-Formats or OpenSlide doesn't mean files in that format will always open (properly) in QuPath. The following sections contain some extra details and caveats, partly based on user feedback about what does and doesn't work.
2929

3030
:::{important}
31-
If you're using a QuPath build for **Apple silicon** (i.e. a recent Mac with M1/M2 processor), then you might not have OpenSlide available by default.
32-
Check out <https://github.com/petebankhead/homebrew-qupath> for instructions how to install this.
31+
If you're using a QuPath build for **Apple silicon** (i.e. a recent Mac with M1/M2/M3 processor), then you might find that *.ndpi* and *.czi* images don't work with Bio-Formats.
3332

34-
The same link can also help if you're using another Mac or Linux computer and want to update the version of OpenSlide that QuPath uses.
33+
See [here](qupath-versions-for-mac) for more details and workarounds.
3534
:::
3635

3736
### Reporting problems

index.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@
66
:::{sidebar} New release online!
77
**QuPath {{ env.config.release }}** is available at [https://qupath.github.io](https://qupath.github.io).
88

9-
This fixes several bugs in v0.4.0 -- including one that prevents the user being told when there's an update.
10-
11-
Note that these docs are still being revised for the latest release.
9+
See what's new in the [changelog](https://github.com/qupath/qupath/blob/main/CHANGELOG.md) - or check out the [I2K YouTube video](https://www.youtube.com/watch?v=tV-BYEHVCw8).
1210
:::
1311

1412
# Welcome to QuPath!
@@ -23,7 +21,7 @@ Can't install QuPath?
2321
: Check out {ref}`installation` for instructions & solutions to common problems
2422

2523
Images won't open?
26-
: See {ref}`supported-image-formats` to find out which formats *should* work - and ways to increase this (including instructions for **Apple silicon** users to install [OpenSlide](https://openslide.org))
24+
: See {ref}`supported-image-formats` to find out which formats *should* work - and ways to increase this.
2725

2826
Not sure where to begin?
2927
: See {ref}`first-steps` for a quick guide, before heading to {ref}`tutorials` for more details & videos

0 commit comments

Comments
 (0)