Skip to content

Commit 7b2b1b6

Browse files
bsipoczrossbar
andauthored
Adding linkcheck (and check for other build problems) (#304)
* Adding linkcheck (and check for other build problems) * DOC: rm dead quansight link. * DOC: Update link to boolean indexing. * DOC: Rm dead link to machinelearningmaster.com * DOC: Replace explicit link with doc xlink. * DOC: replace dead nih blog link with arxiv.org * DOC: Update imageio link. * Rm dead link to raddq.com. * DOC: rm links to cpcb (in/com). The .com link is dead, the .in link consistently times out. * TEX: Add column specifications to tables. Fixes errors (and borked rendering) in static eq tutorial. * DOC: Rm sciencedirect link (403) --------- Co-authored-by: Ross Barnowski <rossbar@caltech.edu>
1 parent e4f4443 commit 7b2b1b6

File tree

7 files changed

+14
-20
lines changed

7 files changed

+14
-20
lines changed

content/tutorial-air-quality-analysis.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ With this, we have successfully imported the data and checked that it is complet
9898
## Calculating the Air Quality Index
9999

100100

101-
We will calculate the AQI using [the method](https://app.cpcbccr.com/ccr_docs/FINAL-REPORT_AQI_.pdf) adopted by the [Central Pollution Control Board](https://www.cpcb.nic.in/national-air-quality-index/) of India. To summarize the steps:
101+
We will calculate the AQI using the method adopted by the Central Pollution Control Board of India. To summarize the steps:
102102

103103
- Collect 24-hourly average concentration values for the standard pollutants; 8-hourly in case of CO and O3.
104104

@@ -366,7 +366,4 @@ Note that this does not mean we can accept the alternative hypothesis. It only t
366366

367367
## Further reading
368368

369-
- There are a host of statistical tests you can choose according to the characteristics of the given data. Read more about them at
370-
[A Gentle Introduction to Statistical Data Distributions](https://machinelearningmastery.com/statistical-data-distributions/).
371-
372369
- There are various versions of the [Student's t-test](https://en.wikipedia.org/wiki/Student%27s_t-test) that you can adopt according to your needs.

content/tutorial-deep-learning-on-mnist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ This tutorial was adapted from the work by [Andrew Trask](https://github.com/iam
3333

3434
The reader should have some knowledge of Python, NumPy array manipulation, and linear algebra. In addition, you should be familiar with main concepts of [deep learning](https://en.wikipedia.org/wiki/Deep_learning).
3535

36-
To refresh the memory, you can take the [Python](https://docs.python.org/dev/tutorial/index.html) and [Linear algebra on n-dimensional arrays](https://numpy.org/numpy-tutorials/content/tutorial-svd.html) tutorials.
36+
To refresh the memory, you can take the [Python](https://docs.python.org/dev/tutorial/index.html) and {doc}`tutorial-svd` tutorials.
3737

3838
You are advised to read the [Deep learning](http://www.cs.toronto.edu/~hinton/absps/NatureDeepReview.pdf) paper published in 2015 by Yann LeCun, Yoshua Bengio, and Geoffrey Hinton, who are regarded as some of the pioneers of the field. You should also consider reading Andrew Trask's [Grokking Deep Learning](https://www.manning.com/books/grokking-deep-learning), which teaches deep learning with NumPy.
3939

content/tutorial-plotting-fractals.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ def divergence_rate(mesh, num_iter=10, radius=2):
207207

208208
The behaviour of this function may look confusing at first glance, so it will help to explain some of the notation.
209209

210-
Our goal is to iterate over each value in the mesh and to tally the number of iterations before the value diverges. Since some values will diverge quicker than others, we need a procedure that only iterates over values that have an absolute value that is sufficiently small enough. We also want to stop tallying values once they surpass the radius. For this, we can use **[Boolean Indexing](https://numpy.org/devdocs/reference/arrays.indexing.html#boolean-array-indexing)**, a NumPy feature that when paired with universal functions is unbeatable. Boolean Indexing allows for operations to be performed conditionally on a NumPy array without having to resort to looping over and checking for each array value individually.
210+
Our goal is to iterate over each value in the mesh and to tally the number of iterations before the value diverges. Since some values will diverge quicker than others, we need a procedure that only iterates over values that have an absolute value that is sufficiently small enough. We also want to stop tallying values once they surpass the radius. For this, we can use **[Boolean Indexing](https://numpy.org/devdocs/user/basics.indexing.html#boolean-array-indexing)**, a NumPy feature that when paired with universal functions is unbeatable. Boolean Indexing allows for operations to be performed conditionally on a NumPy array without having to resort to looping over and checking for each array value individually.
211211

212212
In our case, we use a loop to apply iterations to our function $f(z) = z^2 -1 $ and keep tally. Using Boolean indexing, we only apply the iterations to values that have an absolute value less than 2.
213213

content/tutorial-static_equilibrium.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -304,14 +304,14 @@ RadCF = np.cross(AC, UnitCF)
304304
This lets you represent the tension (T) and reaction (R) forces acting on the system as
305305

306306
$$\left[
307-
\begin{array}
307+
\begin{array}{ccccc}
308308
~1/3 & 1/3 & 1 & 0 & 0\\
309309
-2/3 & -2/3 & 0 & 1 & 0\\
310310
-2/3 & 2/3 & 0 & 0 & 1\\
311311
\end{array}
312312
\right]
313313
\left[
314-
\begin{array}
314+
\begin{array}{c}
315315
~T_{BD}\\
316316
T_{BE}\\
317317
R_{x}\\
@@ -321,7 +321,7 @@ R_{z}\\
321321
\right]
322322
=
323323
\left[
324-
\begin{array}
324+
\begin{array}{c}
325325
~195\\
326326
390\\
327327
-130\\
@@ -331,20 +331,20 @@ R_{z}\\
331331
and the moments as
332332

333333
$$\left[
334-
\begin{array}
334+
\begin{array}{cc}
335335
~2 & -2\\
336336
1 & 1\\
337337
\end{array}
338338
\right]
339339
\left[
340-
\begin{array}
340+
\begin{array}{c}
341341
~T_{BD}\\
342342
T_{BE}\\
343343
\end{array}
344344
\right]
345345
=
346346
\left[
347-
\begin{array}
347+
\begin{array}{c}
348348
~780\\
349349
1170\\
350350
\end{array}

content/tutorial-x-ray-image-processing.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@ on certain parts, and visually compare them using the
2424
[Canny](https://en.wikipedia.org/wiki/Canny_edge_detector) filters for edge
2525
detection.
2626

27-
X-ray image analysis can be part of your data analysis and
28-
[machine learning workflow](https://www.sciencedirect.com/science/article/pii/S235291481930214X)
27+
X-ray image analysis can be part of your data analysis and machine learning workflow
2928
when, for example, you're building an algorithm that helps
3029
[detect pneumonia](https://www.kaggle.com/c/rsna-pneumonia-detection-challenge)
3130
as part of a [Kaggle](https://www.kaggle.com)
@@ -36,8 +35,8 @@ particularly important when images are estimated to account for
3635
medical data.
3736

3837
You'll be working with radiology images from the
39-
[ChestX-ray8](https://www.nih.gov/news-events/news-releases/nih-clinical-center-provides-one-largest-publicly-available-chest-x-ray-datasets-scientific-community)
40-
dataset provided by the [National Institutes of Health (NIH)](http://nih.gov).
38+
[ChestX-ray8](https://arxiv.org/abs/1705.02315)
39+
dataset provided by the [National Institutes of Health (NIH)](https://nih.gov).
4140
ChestX-ray8 contains over 100,000 de-identified X-ray images in the PNG format
4241
from more than 30,000 patients. You can find ChestX-ray8's files on NIH's public
4342
Box [repository](https://nihcc.app.box.com/v/ChestXray-NIHCC) in the `/images`
@@ -69,7 +68,7 @@ The following packages are used in this tutorial:
6968
- [imageio](https://imageio.github.io) for reading and writing image data. The
7069
healthcare industry usually works with the
7170
[DICOM](https://en.wikipedia.org/wiki/DICOM) format for medical imaging and
72-
[imageio](https://imageio.readthedocs.io/en/stable/format_dicom.html) should be
71+
[imageio](https://imageio.readthedocs.io/en/stable/_autosummary/imageio.plugins.dicom.html) should be
7372
well-suited for reading that format. For simplicity, in this tutorial you'll be
7473
working with PNG files.
7574
- [Matplotlib](https://matplotlib.org/) for data visualization.
@@ -517,7 +516,6 @@ download.
517516
To learn more about image processing in the context of biomedical image data or
518517
simply edge detection, you may find the following material useful:
519518

520-
- [DICOM processing and segmentation in Python](https://www.raddq.com/dicom-processing-segmentation-visualization-in-python/) with Scikit-Image and pydicom (Radiology Data Quest)
521519
- [Image manipulation and processing using Numpy and Scipy](https://scipy-lectures.org/advanced/image_processing/index.html) (Scipy Lecture Notes)
522520
- [Intensity values](https://s3.amazonaws.com/assets.datacamp.com/production/course_7032/slides/chapter2.pdf) (presentation, DataCamp)
523521
- [Object detection with Raspberry Pi and Python](https://makersportal.com/blog/2019/4/23/image-processing-with-raspberry-pi-and-python-part-ii-spatial-statistics-and-correlations) (Maker Portal)

site/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ The following links may be useful:
2727
- [Main NumPy documentation](https://numpy.org/doc/stable/)
2828
- [NumPy documentation team meeting notes](https://hackmd.io/oB_boakvRqKR-_2jRV-Qjg?both)
2929
- [NEP 44 - Restructuring the NumPy documentation](https://numpy.org/neps/nep-0044-restructuring-numpy-docs.html)
30-
- [Blog post - Documentation as a way to build Community](https://labs.quansight.org/blog/2020/03/documentation-as-a-way-to-build-community/)
3130

3231
Note that regular documentation issues for NumPy can be found in the [main NumPy
3332
repository](https://github.com/numpy/numpy/issues) (see the `Documentation`

tox.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ commands =
4343

4444
!buildhtml: pytest --nbval-lax --durations=10 content/
4545

46-
buildhtml: bash -c "jupyter-book build --execute --html -d"
46+
buildhtml: bash -c "jupyter-book build --execute --html --strict -d"
4747

4848
pip_pre =
4949
predeps: true

0 commit comments

Comments
 (0)