Shuu12121 commited on
Commit
ecbdebb
Β·
verified Β·
1 Parent(s): e08ecb2

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +50 -13
README.md CHANGED
@@ -14,6 +14,15 @@ library_name: sentence-transformers
14
 
15
  # Shuu12121/Owl-ph2-len2048 πŸ¦‰
16
 
 
 
 
 
 
 
 
 
 
17
  ## Model Details
18
 
19
  ### Model Description
@@ -39,7 +48,7 @@ SentenceTransformer(
39
  (0): Transformer({'max_seq_length': 1024, 'do_lower_case': False, 'architecture': 'ModernBertModel'})
40
  (1): Pooling({'word_embedding_dimension': 768, 'pooling_mode_cls_token': True, 'pooling_mode_mean_tokens': False, 'pooling_mode_max_tokens': False, 'pooling_mode_mean_sqrt_len_tokens': False, 'pooling_mode_weightedmean_tokens': False, 'pooling_mode_lasttoken': False, 'include_prompt': True})
41
  )
42
- ````
43
 
44
  ## Intended Uses
45
 
@@ -73,22 +82,50 @@ The training set contains approximately **100,000 samples per language**, result
73
  * **Epochs:** 1
74
  * **Loss:** MultipleNegativesRankingLoss
75
 
 
 
76
  ## Integrations
77
 
78
- ### Owl-CLI
 
 
 
 
 
 
79
 
80
- This model is used as the embedding model in **[Owl-CLI](https://github.com/Shun0212/Owl-CLI)**, a command-line tool for semantic code search.
81
 
82
- Owl-CLI indexes source code at the **function level**, generates dense embeddings using this model, and performs **vector similarity search** to retrieve relevant code for natural language queries.
 
 
 
 
 
 
83
 
84
- Key features of Owl-CLI include:
85
 
86
- - **Semantic code search** using dense embeddings
87
- - **Function-level indexing** with file paths and line numbers
88
- - **Automatic indexing** on first search
89
- - **Differential embedding cache** to avoid re-embedding unchanged files
90
- - **JSON output** for tool integration
91
- - **MCP server support** for integration with AI coding agents (e.g., Claude Code)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
92
 
93
- Repository:
94
- https://github.com/Shun0212/Owl-CLI
 
14
 
15
  # Shuu12121/Owl-ph2-len2048 πŸ¦‰
16
 
17
+ ```
18
+ β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•— β–ˆβ–ˆβ•— β–ˆβ–ˆβ•—β–ˆβ–ˆβ•— β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•— β–ˆβ–ˆβ•— β–ˆβ–ˆβ•—
19
+ β–ˆβ–ˆβ•”β•β•β•β–ˆβ–ˆβ•—β–ˆβ–ˆβ•‘ β–ˆβ–ˆβ•‘β–ˆβ–ˆβ•‘ β–ˆβ–ˆβ•”β•β•β•β•β• β–ˆβ–ˆβ•‘ β–ˆβ–ˆβ•‘ ,______,
20
+ β–ˆβ–ˆβ•‘ β–ˆβ–ˆβ•‘β–ˆβ–ˆβ•‘ β–ˆβ•— β–ˆβ–ˆβ•‘β–ˆβ–ˆβ•‘ β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•— β–ˆβ–ˆβ•‘ β–ˆβ–ˆβ•‘ β–ˆβ–ˆβ•‘ ( O v O )
21
+ β–ˆβ–ˆβ•‘ β–ˆβ–ˆβ•‘β–ˆβ–ˆβ•‘β–ˆβ–ˆβ–ˆβ•—β–ˆβ–ˆβ•‘β–ˆβ–ˆβ•‘ β•šβ•β•β•β•β•β• β–ˆβ–ˆβ•‘ β–ˆβ–ˆβ•‘ β–ˆβ–ˆβ•‘ / V \
22
+ β•šβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•”β•β•šβ–ˆβ–ˆβ–ˆβ•”β–ˆβ–ˆβ–ˆβ•”β•β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•— β•šβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•— β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•— β–ˆβ–ˆβ•‘ /( )\
23
+ β•šβ•β•β•β•β•β• β•šβ•β•β•β•šβ•β•β• β•šβ•β•β•β•β•β•β• β•šβ•β•β•β•β•β• β•šβ•β•β•β•β•β•β• β•šβ•β• ^^ ^^
24
+ ```
25
+
26
  ## Model Details
27
 
28
  ### Model Description
 
48
  (0): Transformer({'max_seq_length': 1024, 'do_lower_case': False, 'architecture': 'ModernBertModel'})
49
  (1): Pooling({'word_embedding_dimension': 768, 'pooling_mode_cls_token': True, 'pooling_mode_mean_tokens': False, 'pooling_mode_max_tokens': False, 'pooling_mode_mean_sqrt_len_tokens': False, 'pooling_mode_weightedmean_tokens': False, 'pooling_mode_lasttoken': False, 'include_prompt': True})
50
  )
51
+ ```
52
 
53
  ## Intended Uses
54
 
 
82
  * **Epochs:** 1
83
  * **Loss:** MultipleNegativesRankingLoss
84
 
85
+ ---
86
+
87
  ## Integrations
88
 
89
+ ### πŸ¦‰ Owl-CLI β€” Semantic Code Search in Your Terminal
90
+
91
+ > **Repository:** [https://github.com/Shun0212/Owl-CLI](https://github.com/Shun0212/Owl-CLI)
92
+
93
+ **Owl-ph2-len2048** is the embedding backbone of **[Owl-CLI](https://github.com/Shun0212/Owl-CLI)**, a command-line tool for semantic code search powered by dense retrieval.
94
+
95
+ Owl-CLI indexes your codebase at the **function level**, encodes each function using this model, and performs **vector similarity search** to find relevant code for natural language queries β€” directly from your terminal.
96
 
97
+ #### Key Features
98
 
99
+ | Feature | Description |
100
+ |---|---|
101
+ | Semantic search | Natural language β†’ relevant functions via dense embeddings |
102
+ | Function-level indexing | Indexed with file paths and line numbers |
103
+ | Differential cache | Only re-embeds changed files |
104
+ | JSON output | Easy integration with other tools and scripts |
105
+ | MCP server support | Plug into AI coding agents (e.g., Claude Code, Cursor) |
106
 
107
+ #### Example: Query Routing
108
 
109
+ ![example-routing](https://raw.githubusercontent.com/Shun0212/Owl-CLI/main/docs/images/example-routing.png)
110
+
111
+ #### Example: Interactive Session
112
+
113
+ ![example-session](https://raw.githubusercontent.com/Shun0212/Owl-CLI/main/docs/images/example-session.png)
114
+
115
+ #### Quick Start
116
+
117
+ ```bash
118
+ # Install
119
+ git clone https://github.com/Shun0212/Owl-CLI.git
120
+
121
+ # Index your codebase and search
122
+ owl search "function that handles authentication"
123
+
124
+ # JSON output for tool integration
125
+ owl search "parse config file" --json
126
+
127
+ # Start MCP server for AI agent integration
128
+ owl mcp
129
+ ```
130
 
131
+ For full documentation and installation instructions, see the [Owl-CLI repository](https://github.com/Shun0212/Owl-CLI).