Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ligmitz/rimcol
A rust crate to convert grayscale images to rgb images.
https://github.com/ligmitz/rimcol
command-line-tool rust tensorflow
Last synced: about 1 month ago
JSON representation
A rust crate to convert grayscale images to rgb images.
- Host: GitHub
- URL: https://github.com/ligmitz/rimcol
- Owner: ligmitz
- License: mit
- Created: 2022-01-25T19:01:05.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-25T18:02:32.000Z (about 2 years ago)
- Last Synced: 2024-11-15T07:44:38.272Z (2 months ago)
- Topics: command-line-tool, rust, tensorflow
- Language: PureBasic
- Homepage: https://crates.io/crates/rimcol
- Size: 20.2 MB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# **rimcol**
**rimcol - Rust Image Coloriser** is a command line tool for converting grayscale images to RGB images.
---
**rimcol** stands for *rust image coloriser*. It is a command line tool written in rust to predict the rgb color pallete of a grayscale image using a CNN model written in tensorflow and python. The input image should be a **256*256** grayscale image and the output is an RGB image of the same dimension.
**Note**: The model is still in its early stages and is evolved to be more accurate with each iteration.
---
Command-line options
* **-i**, **--path-to-input** (Parameter): Pass the input grayscale image location.
* **-o**, **--path-for-output** (Parameter): Pass the output location for saving the RGB image.
* **-h**, **--help**: Get the help info.
---
Installation
rimcol currently can be used in 3 ways, install via [cargo](https://doc.rust-lang.org/cargo/), build from source and use as a rust package.
Before installing, download the model from here,
extract it and place the folder at `/home//`.
**Note**: rimcol depends on tensorflow for running the CNN model, so you should have tensorflow prerequisites installed. Refer [tensorflow-rust](https://github.com/tensorflow/rust).
## Manual installation from GitHub
Compiled binary versions of rimcol are uploaded to GitHub when a release is made.
You can install rimcol manually by [downloading a release](https://github.com/ligmitz/rimcol/releases), extracting it, and copying the binary to a directory in your `$PATH`, such as `/usr/local/bin`.
## Cargo
If you already have a Rust environment set up, you can use the `cargo install` command:
$ cargo install rimcol
Cargo will build the `rimcol` binary and place it in `$HOME/.cargo`.
## As a package
If you want to use rimcol as a package in your rust project, add this to your `Cargo.toml` file:
```
rimcol = "0.1.0"
```
---
rimcol is written in [Rust](https://www.rust-lang.org/).
You will need rustc version 1.57.0 or higher.
The recommended way to install Rust for development is from the [official download page](https://www.rust-lang.org/tools/install), using rustup.
Once Rust is installed, you can compile the rimcol directory cloned from github with Cargo:
$ cargo build
- If you want to compile a version for yourself, run `cargo build --release`.
Copy the resulting binary, which will be in the `target/release` directory, into a folder in your `$PATH` such as `/usr/local/bin`.