Just a bunch of spelling fixes (#3760)

bacalhau-project · Apr 27, 2024 · 3e4e929 · 3e4e929
1 parent 6181941
commit 3e4e929
Show file tree

Hide file tree

Showing 15 changed files with 65 additions and 14 deletions.
diff --git a/.cspell/custom-dictionary.txt b/.cspell/custom-dictionary.txt
@@ -4,6 +4,7 @@ Addrs
 alessio
 apimodels
 armv
+astype
 authorised
 autofetch
 automagically
@@ -39,10 +40,14 @@ configflags
 configmap
 coreiface
 Crossentropy
+cslint
 CUDA
 cyberattacks
 daaronch
+dask
+Dask
 datacatalog
+davidgasquez
 dbname
 DBPASSWORD
 defence
@@ -62,12 +67,14 @@ dylibso
 Emptyf
 Errln
 esbenp
+ethereumetl
 Evals
 Existsf
 expanso
 extendee
 Failf
 fanout
+fastavro
 filefs
 filplus
 filterz
@@ -84,13 +91,15 @@ flyteorg
 flytepropeller
 fnames
 fsrepo
+fsspec
 ftype
 funct
 funlen
 getcwd
 gettimeout
 gitlfs
 gitprecommit
+gmounting
 GOARCH
 GOBIN
 GOCACHE
@@ -116,6 +125,7 @@ gosec
 gosimple
 GOVER
 govet
+groupby
 gserviceaccount
 healthz
 helloworld
@@ -152,16 +162,22 @@ ipynb
 isatty
 isort
 isource
+itable
 jbtj
 jetstack
 JOBID
 jobspec
 jobstore
 jobtype
 jobutils
+journalctl
 jridgewell
+jsace
+jsacex
 jsonbs
+Kaggle
 Keras
+klass
 kthnx
 kubo
 kwtypes
@@ -190,8 +206,10 @@ merkledag
 Meslo
 millicore
 Millicores
+missingok
 mitchellh
 MNIST
+mnmean
 modelsutils
 modtidy
 mogrify
@@ -203,15 +221,19 @@ multierror
 multiformats
 Muxed
 mypy
+nats
 nbconvert
 nemt
+NOAA
 nocheck
 noctx
 nodeid
 noheader
 nohup
 nolint
+Normalise
 nosec
+notifempty
 numpy
 nums
 oidc
@@ -235,19 +257,24 @@ phayes
 PKCS
 pmmmwh
 popd
+Postino
 projectcontour
 proto
 protobuf
 protoc
 protoimpl
+prysm
 publicapi
 pushd
+pyarrow
 pyenv
 pyflyte
 Pylance
 pypi
 pypoetry
+pyseaflux
 PYTHONVER
+querys
 quic
 quickstart
 rabbitmq
@@ -266,14 +293,19 @@ ripath
 rpad
 samber
 Sched
+scipy
 scminput
 sdkmetric
 sdktrace
+Sectigo
 sharded
 shellescape
+shutil
+SOCAT
 sockjs
 softmax
 sparkoperator
+Sparkov
 stackdriver
 stretchr
 stringutils
@@ -284,10 +316,12 @@ swipl
 testdata
 testid
 tfvars
+tlscert
 touchfs
 traceid
 ttps
 UCAN
+Ultralytics
 unacked
 uncompiled
 uncompress
@@ -298,6 +332,7 @@ ungzip
 unixfs
 unixfsnode
 unmarshals
+unsharded
 untar
 unwritable
 upgrader
@@ -320,7 +355,14 @@ winderresearch
 workdir
 Wrapf
 writefile
+xarray
 xlarge
 xmap
 xvfz
+YOLO
+yolov
+yyyymmddhhmm
+zarr
 zerolog
+zidane
+HMAC
diff --git a/docs/docs/community/compute-landscape.md b/docs/docs/community/compute-landscape.md
@@ -48,7 +48,7 @@ The table below summarizes their score in terms of different requirements. The r
 ![image](../../static/img/landscape/landscape-table.png 'Compute Framework Analysis')
 
 
-**Why is Bachalau not on this list?** This analysis is not a direct comparison between Bacalhau and existing frameworks. Instead, this research aims to help the Bacalhau community to learn more about the benefits and drawbacks of traditional systems.
+**Why is Bacalhau not on this list?** This analysis is not a direct comparison between Bacalhau and existing frameworks. Instead, this research aims to help the Bacalhau community to learn more about the benefits and drawbacks of traditional systems.
 
 ## Code repository
 

diff --git a/docs/docs/community/social-media.md b/docs/docs/community/social-media.md
@@ -16,7 +16,7 @@ The [Bacalhau YouTube channel](https://www.youtube.com/channel/UC45IQagLzNR3wdNC
 
 Subscribe to the [Bacalhau newsletter](https://bacalhau.substack.com/) for official project updates sent straight to your inbox.
 
-Also, our blog contains product updates, company news, and educational content on how you can leverage Bacalhau and the Compute over Data ecosytem [Bacalhau Blog](https://bacalhau.substack.com/).
+Also, our blog contains product updates, company news, and educational content on how you can leverage Bacalhau and the Compute over Data ecosystem [Bacalhau Blog](https://bacalhau.substack.com/).
 
 ## Twitter
 

diff --git a/docs/docs/community/style-guide.md b/docs/docs/community/style-guide.md
@@ -152,7 +152,7 @@ The callout blocks include:
 
 - **caution**: Use to make the reader aware they need to be careful when acting on some advice.
 
-- **warning**: Use to indicate that there are dangers or consequenses associated with some information or steps.
+- **warning**: Use to indicate that there are dangers or consequences associated with some information or steps.
 
 Here’s a Markdown example of a **tip** callout block.
 

diff --git a/docs/docs/examples/data-engineering/blockchain-etl/index.md b/docs/docs/examples/data-engineering/blockchain-etl/index.md
@@ -479,7 +479,7 @@ sudo geth --datadir /mnt/disks/ethereum/ attach
 
 Once the block sync has started, `eth.syncing` will return values. Before it starts, this value will be `false`.
 
-Note that by default, geth will perform a fast sync, without downloading the full blocks. The `syncmode=flull` flag forces geth to do a full sync. If we didn't do this, then we wouldn't be able to back up the data properly.
+Note that by default, geth will perform a fast sync, without downloading the full blocks. The `syncmode=full` flag forces geth to do a full sync. If we didn't do this, then we wouldn't be able to back up the data properly.
 
 ### Extracting the Data
 

diff --git a/docs/docs/examples/data-engineering/image-processing/index.md b/docs/docs/examples/data-engineering/image-processing/index.md
@@ -66,8 +66,8 @@ Bacalhau also mounts a data volume to store output data. The `bacalhau docker ru
 bacalhau list --id-filter=${JOB_ID} --no-style
 ```
 
-     CREATED   ID        JOB                      STATE      VERIFIED  PUBLISHED
-     00:26:44  bf785b4d  Docker dpokidov/imag...  Completed            ipfs://QmQnern37ueHr...
+     CREATED   ID        JOB                       STATE      VERIFIED  PUBLISHED
+     00:26:44  bf785b4d  Docker dpokidov/image...  Completed            ipfs://QmQnern37ueHr...
 
 
 When it says `Published` or `Completed`, that means the job is done, and we can get the results.

diff --git a/docs/docs/examples/data-engineering/oceanography-conversion/index.md b/docs/docs/examples/data-engineering/oceanography-conversion/index.md
@@ -2,6 +2,7 @@
 sidebar_label: "Oceanography - Data Conversion"
 sidebar_position: 5
 description: "Oceanography data conversion with Bacalhau"
+# cspell:ignore fco2, pco2, uatm, unwtd, xlon, ylat, tmnth, bafybeidunikexxu5qtuwc7eosjpuw6a75lxo7j5ezf3zurv52vbrmqwf6y, sortby, dtype, ufunc
 ---
 # Oceanography - Data Conversion
 
@@ -68,13 +69,15 @@ with fsspec.open("./inputs/SOCATv2022_tracks_gridded_monthly.nc.zip", compressio
 ds.info()
 ```
 
-
+<!--- cslint:disable -->
 ```python
 time_slice = slice("2010", "2020") # select a decade
+<!--- cslint:enable -->
 res = ds['sst_ave_unwtd'].sel(tmnth=time_slice).mean(dim='tmnth') # average over time
 res.plot() # plot the result
 
 ```
+<!--- cslint:enable -->
 
 We can see that the dataset contains lat-long coordinates, the date, and a series of seawater measurements. Above you can see a plot of the average surface sea temperature (sst) between 2010-2020, where recording buoys and boats have traveled.
 
@@ -99,8 +102,6 @@ For the purposes of this example:
 
 This resulted in the IPFS CID of `bafybeidunikexxu5qtuwc7eosjpuw6a75lxo7j5ezf3zurv52vbrmqwf6y`.
 
-
-
 ```python
 %%writefile main.py
 import fsspec
@@ -184,6 +185,7 @@ def main():
 if __name__ == "__main__":
     main()
 ```
+<!--- cslint:enable -->
 
 ## Setting up Docker Container
 

diff --git a/docs/docs/examples/model-inference/object-detection-yolo5/index.md b/docs/docs/examples/model-inference/object-detection-yolo5/index.md
@@ -111,7 +111,9 @@ Now let's use some custom images. First, you will need to ingest your images ont
 
 This example will use the [Cyclist Dataset for Object Detection | Kaggle](https://www.kaggle.com/datasets/f445f341fc5e3ab58757efa983a38d6dc709de82abd1444c8817785ecd42a1ac) dataset.
 
+<!-- cspell: disable -->
 We have already uploaded this dataset to Filecoin under the CID: `bafybeicyuddgg4iliqzkx57twgshjluo2jtmlovovlx5lmgp5uoh3zrvpm`. You can browse to this dataset via [a HTTP IPFS proxy](https://w3s.link/ipfs/bafybeicyuddgg4iliqzkx57twgshjluo2jtmlovovlx5lmgp5uoh3zrvpm).
+<!-- cspell: enable -->
 
 Let's run a the same job again, but this time use the images above.
 

diff --git a/docs/docs/examples/model-training/Stable-Diffusion-Dreambooth/index.md b/docs/docs/examples/model-training/Stable-Diffusion-Dreambooth/index.md
diff --git a/docs/docs/setting-up/other-specifications/engines/docker.md b/docs/docs/setting-up/other-specifications/engines/docker.md
@@ -1,5 +1,6 @@
 ---
 sidebar_label: Docker
+# cspell: ignore myvalue
 ---
 
 # Docker Engine Specification

diff --git a/docs/docs/setting-up/running-node/configuring-tls.md b/docs/docs/setting-up/running-node/configuring-tls.md
@@ -75,4 +75,4 @@ If you use self-signed certificates, it is unlikely that any clients will be abl
 
 2. Install the CA certificate file in the system keychain of each machine that needs access to the Bacalhau APIs.
 
-3. Instruct the software librarary you are using not to verify HTTPS requests.
+3. Instruct the software library you are using not to verify HTTPS requests.
diff --git a/docs/docs/setting-up/running-node/gpu.md b/docs/docs/setting-up/running-node/gpu.md
@@ -2,6 +2,7 @@
 sidebar_label: 'GPU Support'
 sidebar_position: 160
 description: How to enable GPU support on your Bacalhau node.
+# cspell: ignore nvidia, amd, intel, rocm, xpumanager, xpumd, xpumcli, kfd, dri, nvidia-smi, rocm-smi, xpu-smi
 ---
 
 # GPU Support

diff --git a/docs/docs/setting-up/workload-onboarding/CUDA/index.md b/docs/docs/setting-up/workload-onboarding/CUDA/index.md
@@ -1,6 +1,7 @@
 ---
 sidebar_label: "CUDA"
 sidebar_position: 10
+# cspell: ignore nvcc, cudnn, Bacalhau, timeit, expt, memcpy, devel
 ---
 # Run CUDA programs on Bacalhau
 

diff --git a/docs/docs/setting-up/workload-onboarding/Python-Custom-Container/index.md b/docs/docs/setting-up/workload-onboarding/Python-Custom-Container/index.md
@@ -92,6 +92,7 @@ pip install -r requirements.txt
 Create a new file called `similar-movies.py` and in it paste the following script
 
 
+<!-- cspell: disable -->
 ```python
 %%writefile similar-movies.py
 # Imports
@@ -166,7 +167,7 @@ sliced = evecs[:, :k] # representative data
 top_indexes = top_cosine_similarity(sliced, movie_id, top_n)
 print_similar_movies(movie_data, movie_id, top_indexes)
 ```
-
+<!-- cspell: enable -->
 
 What the similar-movies.py script does
 

diff --git a/pkg/s3/test/suite.go b/pkg/s3/test/suite.go
@@ -118,7 +118,7 @@ func (s *HelperSuite) SetupSuite() {
 	}
 
 	// unique runID added to prefix to avoid collisions
-	timestamp := time.Now().UTC().Format("20060102T150405") // yyyyMMddThhmmss
+	timestamp := time.Now().UTC().Format("20060102T150405") // yyyyMMddThhmmss // cspell: disable-line
 	s.JobID = uuid.NewString()
 	s.ExecutionID = uuid.NewString()
 	s.RunID = timestamp + "-" + uuid.NewString()