lytang commited on
Commit
7e512de
1 Parent(s): ac01047

Enable installing MiniCheck as a package

Browse files
Files changed (1) hide show
  1. README.md +5 -2
README.md CHANGED
@@ -47,13 +47,16 @@ fact-checking model despite its small size.**
47
 
48
  # Model Usage
49
 
50
- Please first clone our [GitHub Repo](https://github.com/Liyan06/MiniCheck) and install necessary packages from `requirements.txt`.
51
-
 
 
52
 
53
  ### Below is a simple use case
54
 
55
  ```python
56
  from minicheck.minicheck import MiniCheck
 
57
  os.environ["CUDA_VISIBLE_DEVICES"] = "0"
58
 
59
  doc = "A group of students gather in the school library to study for their upcoming final exams."
 
47
 
48
  # Model Usage
49
 
50
+ Please run the following command to install the **MiniCheck package** and all necessary dependencies.
51
+ ```sh
52
+ pip install "minicheck[llm] @ git+https://github.com/Liyan06/MiniCheck.git@main"
53
+ ```
54
 
55
  ### Below is a simple use case
56
 
57
  ```python
58
  from minicheck.minicheck import MiniCheck
59
+ import os
60
  os.environ["CUDA_VISIBLE_DEVICES"] = "0"
61
 
62
  doc = "A group of students gather in the school library to study for their upcoming final exams."