Skip to content

Update ADVANCED-USERS.md #1396

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Dec 11, 2024
Merged

Update ADVANCED-USERS.md #1396

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6021e9e
Update ADVANCED-USERS.md
mikekgfb Nov 27, 2024
fa269bb
Merge branch 'pytorch:main' into patch-20
mikekgfb Dec 7, 2024
4afdea5
Merge branch 'main' into patch-20
Jack-Khuu Dec 9, 2024
d2a4831
Update ADVANCED-USERS.md
mikekgfb Dec 10, 2024
f074c98
Merge branch 'pytorch:main' into patch-20
mikekgfb Dec 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions docs/ADVANCED-USERS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,20 @@
> [!WARNING]
> Files in this directory may be outdated, incomplete, scratch notes, or a WIP. torchchat provides no guarantees on these files as references. Please refer to the root README for stable features and documentation.

# Torchchat is still in pre-release!


Torchchat is currently in a pre-release state and under extensive development.


# The Lost Manual: torchchat

[**Introduction**](#introduction) | [**Installation**](#installation) | [**Get Started**](#get-started) | [**Download**](#download) | [**Chat**](#chat) | [**Generate**](#generate) | [**Eval**](#eval) | [**Export**](#export) | [**Supported Systems**](#supported-systems) | [**Contributing**](#contributing) | [**License**](#license)

<!--

[shell default]: HF_TOKEN="${SECRET_HF_TOKEN_PERIODIC}" huggingface-cli login

[shell default]: ./install/install_requirements.sh

[shell default]: TORCHCHAT_ROOT=${PWD} ./torchchat/utils/scripts/install_et.sh

-->

This is the advanced users' guide, if you're looking to get started
with LLMs, please refer to the README at the root directory of the
Expand Down Expand Up @@ -465,7 +463,7 @@ significant impact on accuracy.

## Native (Stand-Alone) Execution of Exported Models

Refer to the [README](README.md] for an introduction to native
Refer to the [README](README.md) for an introduction to native
execution on servers, desktops, and laptops. Mobile and Edge execution for Android and iOS are
described under [torchchat/edge/docs/Android.md] and [torchchat/edge/docs/iOS.md], respectively.

Expand Down
Loading