Repository navigation
chore: prepare crates for the first crates.io release - #1
Merged
Merged
Conversation
Drop `publish = false`, add rust-version, keywords, categories and docs.rs metadata, ship LICENSE in both packages, exclude the golden fixtures and scripts from candle-timestral, and make README links absolute. CI now also checks docs, a build without default features, `cargo package` and the MSRV. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Pushing a `vX.Y.Z` tag on main publishes both crates via crates.io trusted publishing and creates (or fills in) the GitHub Release with notes generated by git-cliff from Conventional Commits. Both crates take one shared version from `[workspace.package]`; the workflow checks that it and the `candle-timestral` requirement match the tag. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Make the internal modules of candle-timestral private, keeping their public items re-exported at the crate root, and restrict architecture helpers to the crate. Mark public enums and structs that are likely to grow as `#[non_exhaustive]`, with builders for `ForecastOptions`, `TimestralForecaster` and `ForecastRequest` instead of struct literals and public fields. `TimestralForecaster` and `TimestralModel` implement `Debug`. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Rename `from_pretrained` to `from_hub`, matching the `hub` feature, and only accept Hub repo ids; `from_dir` loads a local checkpoint directory. Both examples use `from_hub` and require the `hub` feature. This makes `loading::resolve_checkpoint` unnecessary, so make the `loading` module, `load_model` and `Config::validate` crate-private. `Config::from_file` stays public to build a `TimestralModel` over weights from a custom `VarBuilder`. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Gets
candle-timestralanddatafusion-forecastready for their first release on crates.io.publish = false; addrust-version, keywords, categories and docs.rs metadata; shipLICENSEin both packages; exclude golden fixtures and scripts fromcandle-timestral; make README links absolute.cargo packageand the MSRV.vX.Y.Ztag onmainpublishes both crates via crates.io trusted publishing and creates the GitHub Release with git-cliff notes. Both crates share one version from[workspace.package], and the workflow checks it against the tag.candle-timestralmodules are now private, with their public items re-exported at the crate root. Growable types are#[non_exhaustive], andForecastOptions,TimestralForecasterandForecastRequestget builders.from_pretrainedis renamed toTimestralForecaster::from_hub(Hub repo ids only, behind thehubfeature).from_dirloads local checkpoints.loading,load_modelandConfig::validateare now crate-private.Test plan
cargo package, MSRV)🤖 Generated with Claude Code