Skip to content

Commit

Permalink
Update documentation for new fork.
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexhuszagh committed Dec 13, 2024
1 parent 0424577 commit 641362e
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 2 deletions.
23 changes: 22 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,27 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.

## [Unreleased]

## [0.1.0][v0.1.0] - 2024-12-12 <a name="0.1.0"></a>

## Changed

- Forked the repository
- Lowered the MSRV to 1.60.0.
- Changed from `repr(transparent)` to `repr(C)`.

## Removed

- All features, including `zerocopy`, `serde`, `bytemuck`, `num-traits`, and `alloc` support.

## Fixed

- Disabled hardware instrinsics by default for `f16` to `f64` and `f64` to `f16` conversions, due to lossy results with an intermediate `f32` (see [#161](https://github.com/starkat99/half-rs/issues/116)).
- Silenced most clippy lints.

# Half Changelog

These were all changes for half, which `float16` is a fork of.

## [2.4.1] - 2024-04-06 <a name="2.4.1"></a>

### Fixed
Expand Down Expand Up @@ -444,7 +465,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
<!-- Versions -->

[Unreleased]: https://github.com/starkat99/half-rs/compare/v2.4.1...HEAD
[2.4.1]: https://github.com/starkat99/half-rs/compare/v2.4.0...v2.4.1
[v0.1.0]: https://github.com/starkat99/half-rs/compare/v2.4.0...v2.4.1
[2.4.0]: https://github.com/starkat99/half-rs/compare/v2.3.1...v2.4.0
[2.3.1]: https://github.com/starkat99/half-rs/compare/v2.3.0...v2.3.1
[2.3.0]: https://github.com/starkat99/half-rs/compare/v2.2.1...v2.3.0
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

This crate implements a half-precision floating point `f16` type for Rust implementing the IEEE 754-2008 standard [`binary16`](https://en.wikipedia.org/wiki/Half-precision_floating-point_format) a.k.a "half" format, as well as a `bf16` type implementing the [`bfloat16`](https://en.wikipedia.org/wiki/Bfloat16_floating-point_format) format.

This is a minimal variant which removes some features and introduce many build dependencies. It also allows the crate to run on much older versions of rustc (1.59+) while retaining the performance, still using intrinsics when available (Rust 1.63+ on ARM64 and Rust 1.68+ on x86/x86_64). If you would like to use this, we recommend converting to or from the analogous types in [half](https://crates.io/crates/half), which this crate was based off of.
This is a minimal variant which removes some features and introduce many build dependencies. It also allows the crate to run on much older versions of rustc (1.60+) while retaining the performance, still using intrinsics when available (Rust 1.63+ on ARM64 and Rust 1.68+ on x86/x86_64). If you would like to use this, we recommend converting to or from the analogous types in [half](https://crates.io/crates/half), which this crate was based off of.

## Usage

Expand Down

0 comments on commit 641362e

Please sign in to comment.