sachiniyer / candle-exercises

Rustlings style exercises for candle
0 stars 1 forks source link

Clarify Build/Run Instructions #1

Open aminoa opened 2 months ago

aminoa commented 2 months ago

I would appreciate further instructions on going through these exercises. Attempting to run rustlings watch on this repo gives

thread 'main' panicked at src/main.rs:113:10:
called `Result::unwrap()` on an `Err` value: Error { inner: TomlError { message: "missing field `path`", raw: Some("# The format version is an indicator of the compatibility of third-party exercises with the\r\n# Rustlings program.\r\n# The format version is not the same as the version of the Rustlings program.\r\n# In case Rustlings makes an unavoidable breaking change to the expected format of third-party\r\n# exercises, you would need to raise this version and adapt to the new format.\r\n# Otherwise, the newest version of the Rustlings program won't be able to run these exercises.\r\nformat_version = 1\r\n\r\n# Optional multi-line message to be shown to users when just starting with the exercises.\r\nwelcome_message = \"\"\"Welcome to candle-exercies.\"\"\"\r\n\r\n# Optional multi-line message to be shown to users after finishing all exercises.\r\nfinal_message = \"\"\"We hope that you found the exercises helpful :D\"\"\"\r\n\r\n# Repeat this section for every exercise.\r\n# [[exercises]]\r\n# Exercise name which is the exercise file name without the `.rs` extension.\r\n# name = \"???\"\r\n\r\n# Optional directory name to be provided if you want to organize exercises in directories.\r\n# If `dir` is specified, the exercise path is `exercises/DIR/NAME.rs`\r\n# Otherwise, the path is `exercises/NAME.rs`\r\n# dir = \"???\"\r\n\r\n# Rustlings expects the exercise to contain tests and run them.\r\n# You can optionally disable testing by setting `test` to `false` (the default is `true`).\r\n# In that case, the exercise will be considered done when it just successfully compiles.\r\n# test = true\r\n\r\n# Rustlings will always run Clippy on exercises.\r\n# You can optionally set `strict_clippy` to `true` (the default is `false`) to only consider\r\n# the exercise as done when there are no warnings left.\r\n# strict_clippy = false\r\n\r\n# A multi-line hint to be shown to users on request.\r\n# hint = \"\"\"???\"\"\"\r\n\r\n[[exercises]]\r\nname = \"tensor\"\r\nhint = \"docs - https://docs.rs/candle-core/latest/candle_core/struct.Tensor.html\"\r\ndir = \"0_mnist\"\r\n\r\n[[exercises]]\r\nname = \"model\"\r\nhint = \"docs\"\r\ndir = \"0_mnist\"\r\n\r\n[[exercises]]\r\nname = \"dataloader\"\r\nhint = \"docs\"\r\ndir = \"0_mnist\"\r\n"), keys: ["exercises"], span: Some(1740..1870) } }
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

I have tried cargo build and cargo run before this but the build command gives errors. Please let me know if you need further information.

sachiniyer commented 2 months ago

Fair point, will add to README and close ticket when I do.