a b/coderpp/clustering/README.md 

  1
  
# Getting started





  
  

  2
  





  
  

  3
  
## System requirements





  
  

  4
  
### Operating system





  
  

  5
  
Ubuntu 18.04.5 LTS





  
  

  6
  
### Software dependencies





  
  

  7
  
Check `environment.yml`.





  
  

  8
  
### Hardware





  
  

  9
  
We are running it on NVIDIA A100 or NVIDIA GeForce RTX 3090





  
  

  10
  





  
  

  11
  
## Installation guide





  
  

  12
  
1. (recommended) Use conda-pack to relocate the conda environment





  
  

  13
  
Tutorial: https://litingchen16.medium.com/how-to-use-conda-pack-to-relocate-your-condo-environment-622b68e077df





  
  

  14
  
Download environment: https://cloud.tsinghua.edu.cn/f/c4248149f5ae4f388766/





  
  

  15
  
Installation time: within 5 mins





  
  

  16
  
2. Use yaml file to create environment





  
  

  17
  
`conda env create -f environment.yml`





  
  

  18
  





  
  

  19
  
## Instruction for use





  
  

  20
  
1. Put your NER vocabulary under `./ner_data/`. Each line of the file is one term.





  
  

  21
  
2. `cd ./utils`, `bash run.sh`.





  
  

  22
  
3. The result is in `./result/final_cluster_res.txt`.





  
  

  23
  





  
  

  24
  
## Demo





  
  

  25
  
1. Run on the data: we've put a demo under `./ner_data/data.txt`. Run the demo with `cd ./utils` and `bash run.sh`.





  
  

  26
  
2. Expected output: you are expected to get the same result as in `./result/final_cluster_res.txt`.





  
  

  27
  
3. Expected run time for demo: 37.438s