-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
03ebb53
commit b7ce524
Showing
4 changed files
with
40 additions
and
2 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Installation | ||
|
||
In order to use Schlandals, you must have the [Rust toolchain installed](https://www.rust-lang.org/tools/install). | ||
Once this is done, you can install Schlandals either using Cargo or from sources. | ||
|
||
## Installing using Cargo | ||
|
||
Run the following command | ||
```bash | ||
cargo install schlandals | ||
``` | ||
|
||
it will install locally the executable. In Unix-based system you should find the executable in `~/.cargo/bin/schlandals`. | ||
|
||
## Installing from sources | ||
|
||
```bash | ||
git clone [email protected]:aia-uclouvain/schlandals.git && cd schlandals && cargo build --release | ||
``` | ||
|
||
it will compile the solver, from sources, and place the executable inside `schlandals/target/release/schlandals`. | ||
|
||
## Optional features | ||
|
||
### Learning with Torch | ||
|
||
It is possible to use the learning module of Schlandals with torch tensors. The torch bindings are provided by the [tch-rs crate](https://github.com/LaurentMazare/tch-rs). | ||
It means that for using this feature, you must libtorch installed on your system. We refer to the [documentation of tch-rs](https://github.com/LaurentMazare/tch-rs?tab=readme-ov-file#getting-started) for the set-up of torch and tch-rs. | ||
|
||
Once torch is installed, and the appropriate variables set, you can run either | ||
```bash | ||
cargo install schlandals --features tensor | ||
``` | ||
or | ||
```bash | ||
cargo build --release --features tensor | ||
``` |
This file contains 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
This file contains 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