Update README.md
Browse files
README.md
CHANGED
|
@@ -35,62 +35,72 @@ More languages may be added in the future.
|
|
| 35 |
|
| 36 |
## Dataset Structure
|
| 37 |
|
| 38 |
-
Each language is stored as a separate compressed file (`.db.gz`)
|
| 39 |
-
|
| 40 |
-
* `it.db.gz` - Italian Wikipedia database (lexical only)
|
| 41 |
-
* `sc.all-mini.db.gz` - Sardinian Wikipedia database (lexical and semantic)
|
| 42 |
|
|
|
|
|
|
|
| 43 |
|
| 44 |
## How to Use This Dataset
|
| 45 |
|
| 46 |
-
1.
|
| 47 |
-
Download a precompiled binary for your operating system from the [Wikilite Releases](https://github.com/eja/wikilite/releases/latest) page. Once downloaded, uncompress the binary.
|
| 48 |
|
| 49 |
-
|
| 50 |
-
Execute the binary with the `--setup` option to install a pre-built database. This command will display a list of available databases, allowing you to select and download the one you need, along with the corresponding GGUF model. For example:
|
| 51 |
|
| 52 |
-
|
| 53 |
-
|
| 54 |
-
```
|
| 55 |
|
| 56 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 57 |
|
| 58 |
-
3.
|
| 59 |
-
|
| 60 |
|
| 61 |
-
|
| 62 |
-
|
| 63 |
-
|
| 64 |
-
|
|
|
|
| 65 |
|
| 66 |
-
|
| 67 |
-
|
| 68 |
-
|
| 69 |
-
|
| 70 |
|
| 71 |
-
|
| 72 |
-
|
|
|
|
|
|
|
|
|
|
| 73 |
|
|
|
|
| 74 |
|
| 75 |
-
|
| 76 |
|
| 77 |
-
[
|
|
|
|
|
|
|
| 78 |
|
| 79 |
-
|
| 80 |
-
* **Enhanced Semantic Search:** Integrates semantic search capabilities, allowing you to find information based on meaning rather than just keywords.
|
| 81 |
-
* **Offline Access:** Enables access to Wikipedia articles without an internet connection.
|
| 82 |
-
* **Command-Line Interface (CLI):** Allows direct searching from the terminal.
|
| 83 |
-
* **Web Interface (Optional):** Provides a user-friendly way to browse and search content.
|
| 84 |
|
| 85 |
-
|
| 86 |
|
| 87 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 88 |
|
| 89 |
-
|
| 90 |
-
|
| 91 |
-
*
|
|
|
|
|
|
|
|
|
|
| 92 |
|
| 93 |
-
|
| 94 |
|
| 95 |
## Contributing
|
| 96 |
|
|
@@ -100,5 +110,5 @@ If you would like to contribute databases for additional languages, please feel
|
|
| 100 |
|
| 101 |
* [Wikipedia](https://www.wikipedia.org/): For providing the valuable data.
|
| 102 |
* [SQLite](https://www.sqlite.org/): For the robust database engine.
|
| 103 |
-
* [LLaMA.cpp](https://github.com/ggml-org/llama.cpp) For enabling the internal generation of embeddings.
|
| 104 |
-
* [Wikilite](https://github.com/eja/wikilite): For
|
|
|
|
| 35 |
|
| 36 |
## Dataset Structure
|
| 37 |
|
| 38 |
+
Each language is stored as a separate compressed file (`.db.gz`). There are two types of databases available:
|
|
|
|
|
|
|
|
|
|
| 39 |
|
| 40 |
+
1. **Lexical Only**: Located in the `lexical/` directory. These support standard FTS5 full-text search (exact word matching) and are lighter in size.
|
| 41 |
+
2. **Semantic & Lexical**: Located in the root or specific model directories. These databases contain **embedded GGUF models** directly within the file structure, enabling both keyword search and vector-based conceptual search without external dependencies.
|
| 42 |
|
| 43 |
## How to Use This Dataset
|
| 44 |
|
| 45 |
+
### 1. Command Line & Web Interface (Linux, macOS, Windows, Termux)
|
|
|
|
| 46 |
|
| 47 |
+
Wikilite runs primarily as a command-line tool that can also serve a local web interface.
|
|
|
|
| 48 |
|
| 49 |
+
1. **Install Wikilite**
|
| 50 |
+
Download the precompiled binary for your operating system from the [Wikilite Releases](https://github.com/eja/wikilite/releases/latest) page and extract it.
|
|
|
|
| 51 |
|
| 52 |
+
2. **Download a Database**
|
| 53 |
+
You can download the `.db.gz` files manually from this repository and extract them, or use Wikilite's built-in tools to handle it for you:
|
| 54 |
+
|
| 55 |
+
* **Interactive Wizard:** Run `./wikilite` without arguments to launch a wizard that guides you through selecting and downloading a database.
|
| 56 |
+
* **Setup Command:** Run `./wikilite --setup` to view and download available databases automatically.
|
| 57 |
|
| 58 |
+
3. **Run Wikilite**
|
| 59 |
+
Once you have a database file (e.g., `wikilite.db`), you can use it in three ways:
|
| 60 |
|
| 61 |
+
* **Interactive Mode:**
|
| 62 |
+
```bash
|
| 63 |
+
./wikilite
|
| 64 |
+
```
|
| 65 |
+
(Follow the on-screen prompts)
|
| 66 |
|
| 67 |
+
* **Command Line Search:**
|
| 68 |
+
```bash
|
| 69 |
+
./wikilite --cli --db <file.db>
|
| 70 |
+
```
|
| 71 |
|
| 72 |
+
* **Web Interface:**
|
| 73 |
+
```bash
|
| 74 |
+
./wikilite --web --db <file.db>
|
| 75 |
+
```
|
| 76 |
+
Access the interface at `http://localhost:35248` in your browser.
|
| 77 |
|
| 78 |
+
### 2. Android Application
|
| 79 |
|
| 80 |
+
A native Android application is available that uses these exact databases.
|
| 81 |
|
| 82 |
+
1. Download the [Android App APK](https://github.com/eja/wikilite/releases/latest/download/wikilite-android.apk).
|
| 83 |
+
2. **External Storage:** If you manually download a `wikilite.db` file from this repository and place it on your external SD card, the app will detect and use it automatically.
|
| 84 |
+
3. **In-App Download:** If no database is found on launch, the app provides an option to download these pre-built databases directly.
|
| 85 |
|
| 86 |
+
## About Wikilite
|
|
|
|
|
|
|
|
|
|
|
|
|
| 87 |
|
| 88 |
+
[Wikilite](https://github.com/eja/wikilite) is a self-contained tool for creating and browsing local SQLite databases of Wikipedia articles.
|
| 89 |
|
| 90 |
+
### Features
|
| 91 |
+
* **Lexical Search:** Uses FTS5 for efficient, exact keyword matching.
|
| 92 |
+
* **Semantic Search:** Uses embedded GGUF models (via llama.cpp integration) contained within the database files to find content based on meaning, synonyms, and conceptual similarity.
|
| 93 |
+
* **Offline Operation:** Complete functionality without internet connectivity.
|
| 94 |
+
* **Cross-Platform:** Available for Linux, macOS, Windows, Termux, and Android.
|
| 95 |
|
| 96 |
+
### Semantic Search Capabilities
|
| 97 |
+
The semantic search functionality employs text embeddings to handle:
|
| 98 |
+
* Query misspellings and typographical errors.
|
| 99 |
+
* Conceptual similarity despite different terminology.
|
| 100 |
+
* Synonym and related term matching.
|
| 101 |
+
* Morphological variations (plurals, verb tenses).
|
| 102 |
|
| 103 |
+
*Note: The semantic databases in this repository are fully self-contained. No external model files or API keys are required.*
|
| 104 |
|
| 105 |
## Contributing
|
| 106 |
|
|
|
|
| 110 |
|
| 111 |
* [Wikipedia](https://www.wikipedia.org/): For providing the valuable data.
|
| 112 |
* [SQLite](https://www.sqlite.org/): For the robust database engine.
|
| 113 |
+
* [LLaMA.cpp](https://github.com/ggml-org/llama.cpp): For enabling the internal generation of embeddings.
|
| 114 |
+
* [Wikilite](https://github.com/eja/wikilite): For the software powering these datasets.
|