Skip to content

Commit

Permalink
Update README.md - improve grammar and use logo URL from GitHub repo
Browse files Browse the repository at this point in the history
  • Loading branch information
gianpaj authored Mar 24, 2024
1 parent 0f47db2 commit 9af0a3a
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# TGS (Terminal Generative Shell)

![TGS Logo](https://www.warpy.io/_next/static/media/tgshell_icon.4fa45b6d.svg) <!-- If you have a logo, you can link it here -->
![TGS Logo](https://raw.githubusercontent.com/warpy-ai/tgs/main/tgshell_icon.svg)

TGS is a conversational shell that combines the power of Rust with the intelligence of GPT-based natural language processing. Designed as a spinoff of the TerminalGPT project, TGS aims to redefine the way users interact with their terminals.
TGS is a conversational shell that combines Rust's power with the intelligence of GPT-based natural language processing. Designed as a spinoff of the TerminalGPT project, it aims to redefine the way users interact with their terminals.

## Features

- **Conversational Interface**: Interact with your terminal in natural language. Instead of remembering complex commands, just tell TGS what you want to do.
- **Rust Integration**: Built with the robustness and efficiency of Rust, ensuring a fast and reliable terminal experience.
- **Conversational Interface**: Interact with your terminal in natural language. Instead of remembering complex commands, tell TGS what you want to do.
- **Rust Integration**: It is built with the robustness and efficiency of Rust, ensuring a fast and reliable terminal experience.
- **Intelligent Suggestions**: TGS provides smart suggestions and corrections, making your terminal experience smoother and more intuitive.
- **Safety Measures**: TGS has built-in safety checks to prevent accidental execution of potentially harmful commands.

Expand Down Expand Up @@ -61,19 +61,19 @@ cargo test

We welcome contributions! Please see our [CONTRIBUTING.md](path_to_contributing.md) for guidelines.

## Working with the probject
## Working with the project

This library relies on the [tch](https://github.com/LaurentMazare/tch-rs) crate for bindings to the C++ Libtorch API.
The libtorch library is required can be downloaded either automatically or manually. The following provides a reference on how to set-up your environment
to use these bindings, please refer to the [tch](https://github.com/LaurentMazare/tch-rs) for detailed information or support.
The `libtorch` library must be downloaded automatically or manually. The following references how to set up your environment
to use these bindings. Please refer to [tch](https://github.com/LaurentMazare/tch-rs) for detailed information and support.

Furthermore, this library relies on a cache folder for downloading pre-trained models.
This cache location defaults to `~/.cache/.rustbert`, but can be changed by setting the `RUSTBERT_CACHE` environment variable. Note that the language models used by this library are in the order of the 100s of MBs to GBs.
The default cache folder is `~/.cache/.rustbert` but can be changed by setting the `RUSTBERT_CACHE` environment variable. Note that the language models used by this library are in the order of 100s of MBs to GBs.

### Manual installation (recommended)

1. Download `libtorch` from https://pytorch.org/get-started/locally/. This package requires `v2.1`: if this version is no longer available on the "get started" page,
the file should be accessible by modifying the target link, for example `https://download.pytorch.org/libtorch/cu118/libtorch-cxx11-abi-shared-with-deps-2.1.1%2Bcu118.zip` for a Linux version with CUDA11. **NOTE:** When using `rust-bert` as dependency from [crates.io](https://crates.io), please check the required `LIBTORCH` on the published package [readme](https://crates.io/crates/rust-bert) as it may differ from the version documented here (applying to the current repository version).
the file should be accessible by modifying the target link, for example `https://download.pytorch.org/libtorch/cu118/libtorch-cxx11-abi-shared-with-deps-2.1.1%2Bcu118.zip` for a Linux version with CUDA11. **NOTE:** When using `rust-bert` as a dependency from [crates.io](https://crates.io), please check the required `LIBTORCH` on the published package [readme](https://crates.io/crates/rust-bert) as it may differ from the version documented here (applying to the current repository version).
2. Extract the library to a location of your choice
3. Set the following environment variables

Expand Down Expand Up @@ -107,13 +107,13 @@ export LD_LIBRARY_PATH=${LIBTORCH}/lib:$LD_LIBRARY_PATH

### Automatic installation

Alternatively, you can let the `build` script automatically download the `libtorch` library for you. The `download-libtorch` feature flag needs to be enabled.
The CPU version of libtorch will be downloaded by default. To download a CUDA version, please set the environment variable `TORCH_CUDA_VERSION` to `cu118`.
Note that the libtorch library is large (order of several GBs for the CUDA-enabled version) and the first build may therefore take several minutes to complete.
Alternatively, you can let the `build` script automatically download the `libtorch` library. The `download-libtorch` feature flag needs to be enabled.
The CPU version of `libtorch` will be downloaded by default. To download a CUDA version, please set the environment variable `TORCH_CUDA_VERSION` to `cu118`.
Note that the libtorch library is large (several GBs for the CUDA-enabled version), and the first build may, therefore, take several minutes to complete.

### Verifying installation

Verify your installation (and linking with libtorch) by adding the `rust-bert` dependency to your `Cargo.toml` or by cloning the rust-bert source and running an example:
Verify your installation (and linking with `libtorch`) by adding the `rust-bert` dependency to your `Cargo.toml` or by cloning the rust-bert source and running an example:

```bash
git clone git@github.com:guillaume-be/rust-bert.git
Expand All @@ -134,7 +134,7 @@ TGS is licensed under the [MIT License](path_to_license.md).

---

Feel free to customize the README further to match the specific features, installation steps, and other details of your project. Remember to replace placeholders (like `<repository_link>`, `path_to_logo.png`, etc.) with actual links or paths as needed.
Feel free to customize the README further to match the specific features, installation steps, and other details of your project. Remember to replace placeholders (like `<repository_link>`, `path_to_logo.png`, etc.) with links or paths as needed.

## Citations

Expand All @@ -154,7 +154,7 @@ Feel free to customize the README further to match the specific features, instal

### For Mac.

In case of running into `torch-sys` error refer to this [solution](https://github.com/LaurentMazare/tch-rs/issues/488#issuecomment-1664261286)
In case of running into `torch-sys` error, refer to this [solution](https://github.com/LaurentMazare/tch-rs/issues/488#issuecomment-1664261286)

## Contributors

Expand All @@ -164,4 +164,4 @@ In case of running into `torch-sys` error refer to this [solution](https://githu

## Acknowledgements

This project is a fork of the [shrs](https://github.com/MrPicklePinosaur/shrs) repository. The core functionality of the CLI architecture is derived from it. We would like to express our gratitude to the original authors for their work. The original project is licensed under Apache-2.0/MIT.
This project is a fork of the [shrs](https://github.com/MrPicklePinosaur/shrs) repository. The core functionality of the CLI architecture is derived from it. We want to express our gratitude to the original authors for their work. The original project is licensed under Apache-2.0/MIT.

0 comments on commit 9af0a3a

Please sign in to comment.