Version 0.2 Compressor: Gaussian Compression Method #94
Conversation
TongtongJin
changed the title
src/Compressors/Gaussian.jl
Outdated
| ## Returns | ||
| - A `Gaussian` object. | ||
| """ | ||
|
|
Codecov ReportAll modified and coverable lines are covered by tests ✅ 📢 Thoughts on this report? Let us know! |
src/Compressors/Gaussian.jl
Outdated
| """ | ||
| Gaussian <: Compressor | ||
|
|
||
| An implementation of the Gaussian compression method. This method forms a Gaussian sketch matrix |
There was a problem hiding this comment.
This line is beyond the allowed character limit
src/Compressors/Gaussian.jl
Outdated
| - `compression_dim::Int64`, the target compression dimension. | ||
| - `n_rows::Int64`, the number of rows of the compression matrix. | ||
| - `n_cols::Int64`, the number of columns of the compression matrix. | ||
| - `scale::Number`, the standard deviation of Gaussian distribution during the compression matrix generation. |
There was a problem hiding this comment.
This line is beyond the character limit
src/Compressors/Gaussian.jl
Outdated
| Gaussian <: Compressor | ||
|
|
||
| An implementation of the Gaussian compression method. This method forms a Gaussian sketch matrix | ||
| with number of rows or number of columns setting as the compression dimension. |
There was a problem hiding this comment.
A simple description may be better. E.g., A specification for a Gaussian compressor.
src/Compressors/Gaussian.jl
Outdated
| end | ||
|
|
||
| function Gaussian(; | ||
| cardinality::Cardinality=Left(), compression_dim::Int64=2, type::Type{<:Number}=Float64 |
There was a problem hiding this comment.
The arguments should be on individual lines to stay with the Blue style.
src/Compressors/Gaussian.jl
Outdated
| # Check on the compression dimension | ||
| function Gaussian(cardinality, compression_dim, type) | ||
| if compression_dim <= 0 | ||
| throw(ArgumentError("Field 'Compression_dim' must be positive.")) |
There was a problem hiding this comment.
Compresion_dim -> compression_dim
src/Compressors/Gaussian.jl
Outdated
There was a problem hiding this comment.
Maybe this file name shouldb elower case to keep with the style of sparse_sign.jl
test/Compressors/Gaussian.jl
Outdated
There was a problem hiding this comment.
Should the file name be lower case?
test/Compressors/Gaussian.jl
Outdated
| typeof(compressor.cardinality) == Card | ||
| end | ||
|
|
||
| for type in [Bool, Int16, Int32, Int64, Float16, Float32, Float64] |
There was a problem hiding this comment.
We probably do not want to test Bool or Integers, since this should not be allowed since we cannot generate a Gaussian random variable of this type.
The pull request includes two new files:
(1) Compressors/Gaussian.jl': Includes implementation of structures and multiplication functions for Gaussian compression method.
(2) test/Compressors/Gaussian.jl: Includes the tests for the multiplication functions, the data structures and the update/complete functions.