pa90 commited on
Commit
419eb6b
·
verified ·
1 Parent(s): 4acc3bb

Update OpenAI_README.txt

Browse files
Files changed (1) hide show
  1. OpenAI_README.txt +21 -47
OpenAI_README.txt CHANGED
@@ -1,73 +1,47 @@
1
- # OpenAI Embedding Originality Analyzer
2
 
3
- Compare the originality of two text passages using OpenAI's text-embedding-3-large model.
4
 
5
- ## Metrics
6
 
7
- - **sem_div (50%)**: Semantic diversity - mean cosine distance between sentence embeddings
8
- - **lex_div (50%)**: Lexical diversity - unique tokens / total tokens
9
- - **Originality Score**: Weighted sum of sem_div and lex_div
10
 
11
- ## Requirements
12
 
13
  - Python 3.8+
14
- - OpenAI API Key (https://platform.openai.com/api-keys)
15
 
16
- ## Installation
17
 
18
- In command prompt:
19
-
20
- ```
21
- pip install gradio openai numpy nltk
22
- ```
23
-
24
- ## Usage
25
-
26
- 1. Download `OpenAI_Originality_GUI.py`
27
-
28
- 2. Run in command prompt:
29
- ```
30
- python OpenAI_Originality_GUI.py
31
- ```
32
-
33
- 3. Browser opens automatically (or go to http://127.0.0.1:7860)
34
-
35
- 4. Enter:
36
- - OpenAI API Key (sk-...)
37
- - Passage A (first paragraph)
38
- - Passage B (second paragraph)
39
 
40
  5. Click Submit
41
 
42
- 6. View results
43
 
44
- ## Interpretation
45
 
46
- | Difference | Judgment |
 
47
  |------------|----------|
48
  | < 5% | Similar |
49
  | 5% - 10% | Some difference |
50
  | 10% - 15% | Significant difference |
51
  | > 15% | Clear difference |
52
 
53
- ## Model Information
54
 
55
  - Model: text-embedding-3-large
56
  - Embedding dimension: 3072
57
  - Provider: OpenAI
58
 
59
- ## Notes
60
-
61
- - API costs apply (check OpenAI pricing)
62
- - Threshold values are empirically derived from pilot testing
63
- - Scores are relative comparisons, not absolute measures
64
-
65
- ## License
66
-
67
- Apache-2.0
68
 
69
- ## Citation
70
 
71
- If you use this tool, please acknowledge:
72
- - OpenAI text-embedding-3-large model
73
- - NLTK for tokenization
 
 
1
 
 
2
 
3
+ # Metrics
4
 
5
+ - **sem_div (50%)**: Semantic diversity - cosine distance between sentence embeddings
6
+ - **lex_div (50%)**: Lexical diversity - variety of word choice
7
+ - **Originality Score**:
8
 
9
+ # Requirements
10
 
11
  - Python 3.8+
12
+ - OpenAI API Key: (https://openai.com/ko-KR/index/openai-api/)
13
 
14
+ # Run sequence
15
 
16
+ 1. Download OpenAI_Originality_GUI.py
17
+ 2. In Command Prompt, type pip install gradio openai numpy nltk and press Enter.
18
+ 3. In Command Prompt, navigate to the folder where OpenAI_Originality_GUI.py is saved.
19
+ 4. Type python OpenAI_Originality_GUI.py and press Enter.
20
+ 5. A browser opens automatically (or go to the URL shown in the terminal).
21
+
22
+ 6. (On the Web UI)
23
+ - Enter the OpenAI API Key
24
+ - Input Passage A
25
+ - Input Passage B
 
 
 
 
 
 
 
 
 
 
 
26
 
27
  5. Click Submit
28
 
 
29
 
 
30
 
31
+ # Interpretation
32
+
33
  |------------|----------|
34
  | < 5% | Similar |
35
  | 5% - 10% | Some difference |
36
  | 10% - 15% | Significant difference |
37
  | > 15% | Clear difference |
38
 
39
+ # Model Information
40
 
41
  - Model: text-embedding-3-large
42
  - Embedding dimension: 3072
43
  - Provider: OpenAI
44
 
 
 
 
 
 
 
 
 
 
45
 
46
+ ## License: Apache-2.0
47