Candlex

ciHex.pmDocs

An Nxbackend for candle machine learning minimalist framework

Installation

If available in Hex, the package can be installed by adding candlex to your list of dependencies in mix.exs:

def deps do
  [
    {:candlex, "~> 0.1.1"}
  ]
end

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/candlex.

Releasing

To publish a new version of this package:

  1. Update @version in mix.exs and PROJECT_VERSION in .github/workflows/binaries.yml.
  2. git tag -s <tag-version> to create new signed tag.
  3. git push origin <tag-version> to push the tag.
  4. Wait for the binaries.yml GitHub workflow to build all the NIF binaries.
  5. mix rustler_precompiled.download Candlex.Native --all to generate binaries checksums locally.
  6. mix hex.build --unpack to check the package includes the correct files.
  7. Publish the release from draft in GitHub.
  8. mix hex.publish to publish package to Hex.pm.

License

Copyright 2023 Mimiquate

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.