Skip to content

update readme #410

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
helloyongyang merged 1 commit into from
Jul 12, 2025
Merged

update readme #410

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<div align="center" style="font-family: charter;">
<h1> LLMC: Towards Accurate and Efficient LLM Compression </h1>
<h1> LightCompress: Towards Accurate and Efficient AIGC Model Compression </h1>

<img src="./imgs/llmc.png" alt="llmc" width="75%" />

Expand All @@ -11,11 +11,13 @@
[![Doc](https://img.shields.io/badge/docs-English-99cc2)](https://llmc-en.readthedocs.io/en/latest/)
[![Doc](https://img.shields.io/badge/文档-中文-99cc2)](https://llmc-zhcn.readthedocs.io/en/latest/)&#160;

**\[ English | [中文](README_zh.md) | [日本語](README_ja.md) \]**
**\[ English | [中文](README_zh.md) \]**

</div>

**LLMC** is an off-the-shell tool designed for compressing LLM, leveraging state-of-the-art compression algorithms to enhance efficiency and reduce model size without compromising performance. You can download the Docker image that can run llmc with the following command. Users in mainland China are recommended to use Alibaba Cloud Docker.
> **📢 Notice**: This repository was formerly known as **LLMC** and has been renamed to **LightCompress**.
**LightCompress** is an off-the-shell tool designed for compressing aigc models(LLM, VLM, Diffusion ...), leveraging state-of-the-art compression algorithms to enhance efficiency and reduce model size without compromising performance. You can download the Docker image that can run LightCompress with the following command. Users in mainland China are recommended to use Alibaba Cloud Docker.
Copy link

@gemini-code-assist gemini-code-assist bot Jul 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

There's a small typo in the description. The term should be "off-the-shelf" instead of "off-the-shell".

Additionally, for improved readability, I suggest adding a space before the opening parenthesis that lists the model types.

Suggested change
**LightCompress** is an off-the-shell tool designed for compressing aigc models(LLM, VLM, Diffusion ...), leveraging state-of-the-art compression algorithms to enhance efficiency and reduce model size without compromising performance. You can download the Docker image that can run LightCompress with the following command. Users in mainland China are recommended to use Alibaba Cloud Docker.
**LightCompress** is an off-the-shelf tool designed for compressing aigc models (LLM, VLM, Diffusion ...), leveraging state-of-the-art compression algorithms to enhance efficiency and reduce model size without compromising performance. You can download the Docker image that can run LightCompress with the following command. Users in mainland China are recommended to use Alibaba Cloud Docker.


```shell
# docker hub: https://hub.docker.com/r/llmcompression/llmc
Expand Down
229 changes: 0 additions & 229 deletions README_ja.md
View file
Open in desktop

This file was deleted.

Loading
Loading