Skip to content

Commit

Permalink
Fix typos (#319)
Browse files Browse the repository at this point in the history
## Describe the changes
Fix some typos in comment
  • Loading branch information
jeremyfelder authored Dec 24, 2023
2 parents 65d4f2b + 263b5d9 commit f9e46d1
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ ICICLE is a CUDA implementation of general functions widely used in ZKP. ICICLE
- Any Nvidia GPU (which supports CUDA Toolkit version 12.0 or above).

> [!NOTE]
> It is possible to use CUDA 11 for cards which dont support CUDA 12, however we dont offically support this version and in the future there may be issues.
> It is possible to use CUDA 11 for cards which dont support CUDA 12, however we dont officially support this version and in the future there may be issues.
### Accessing Hardware

Expand Down
2 changes: 1 addition & 1 deletion icicle/appUtils/msm/msm.cuh
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ namespace msm {
* very frequently. Useful for efficient treatment of non-uniform distributions of
* scalars and "top windows" with few bits. Can be set to 0 to disable separate
* treatment of large buckets altogether. Default value: 10. */
bool is_async; /**< Whether to run the MSM asyncronously. If set to true, the MSM function will be
bool is_async; /**< Whether to run the MSM asynchronously. If set to true, the MSM function will be
* non-blocking and you'd need to synchronize it explicitly by running
* `cudaStreamSynchronize` or `cudaDeviceSynchronize`. If set to false, the MSM
* function will block the current CPU thread. */
Expand Down
2 changes: 1 addition & 1 deletion icicle/appUtils/ntt/ntt.cu
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ namespace ntt {

/**
* NTT/INTT inplace batch
* Note: this function does not preform any bit-reverse permutations on its inputs or outputs.
* Note: this function does not perform any bit-reverse permutations on its inputs or outputs.
* @param d_input Input array
* @param n Size of `d_input`
* @param d_twiddles Twiddles
Expand Down
2 changes: 1 addition & 1 deletion icicle/appUtils/ntt/ntt.cuh
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ namespace ntt {
bool are_inputs_on_device; /**< True if inputs are on device and false if they're on host. Default value: false. */
bool are_outputs_on_device; /**< If true, output is preserved on device, otherwise on host. Default value: false. */
int batch_size; /**< The number of NTTs to compute. Default value: 1. */
bool is_async; /**< Whether to run the NTT asyncronously. If set to `true`, the NTT function will be
bool is_async; /**< Whether to run the NTT asynchronously. If set to `true`, the NTT function will be
* non-blocking and you'd need to synchronize it explicitly by running
* `cudaStreamSynchronize` or `cudaDeviceSynchronize`. If set to false, the NTT
* function will block the current CPU thread. */
Expand Down
4 changes: 2 additions & 2 deletions wrappers/rust/icicle-core/src/msm/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ struct MSMConfig {
int large_bucket_factor; /**< Variable that controls how sensitive the algorithm is to the buckets that occur very frequently.
* Useful for efficient treatment of non-uniform distributions of scalars and "top windows" with few bits.
* Can be set to 0 to disable separate treatment of large buckets altogether. Default value: 10. */
int is_async; /**< Whether to run the MSM asyncronously. If set to `true`, the MSM function will be non-blocking
int is_async; /**< Whether to run the MSM asynchronously. If set to `true`, the MSM function will be non-blocking
* and you'd need to synchronize it explicitly by running `cudaStreamSynchronize` or `cudaDeviceSynchronize`.
* If set to false, the MSM function will block the current CPU thread. */
device_context::DeviceContext ctx; /**< Details related to the device such as its id and stream id. See [DeviceContext](@ref `device_context::DeviceContext`). */
Expand Down Expand Up @@ -88,7 +88,7 @@ pub struct MSMConfig<'a> {
/// Can be set to 0 to disable separate treatment of large buckets altogether. Default value: 10.
pub large_bucket_factor: usize,

/// Whether to run the MSM asyncronously. If set to `true`, the MSM function will be non-blocking
/// Whether to run the MSM asynchronously. If set to `true`, the MSM function will be non-blocking
/// and you'd need to synchronize it explicitly by running `cudaStreamSynchronize` or `cudaDeviceSynchronize`.
/// If set to `false`, the MSM function will block the current CPU thread.
pub is_async: bool,
Expand Down
2 changes: 1 addition & 1 deletion wrappers/rust/icicle-core/src/ntt/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ pub struct NTTConfig<'a, S> {
pub are_outputs_on_device: bool,
/** The number of NTTs to compute. Default value: 1. */
pub batch_size: c_int,
/** Whether to run the NTT asyncronously. If set to `true`, the NTT function will be non-blocking and you'd need to synchronize
/** Whether to run the NTT asynchronously. If set to `true`, the NTT function will be non-blocking and you'd need to synchronize
* it explicitly by running `cudaStreamSynchronize` or `cudaDeviceSynchronize`. If set to false, the NTT
* function will block the current CPU thread. */
pub is_async: bool,
Expand Down

0 comments on commit f9e46d1

Please sign in to comment.