Upload README.md
Browse files
README.md
CHANGED
|
@@ -1,21 +1,3 @@
|
|
| 1 |
-
---
|
| 2 |
-
tags:
|
| 3 |
-
- ai
|
| 4 |
-
- training
|
| 5 |
-
- dsl
|
| 6 |
-
- oktoscript
|
| 7 |
-
- oktoseek
|
| 8 |
-
- okto
|
| 9 |
-
- automation
|
| 10 |
-
- ai-pipelines
|
| 11 |
-
- ai-governance
|
| 12 |
-
language:
|
| 13 |
-
- en
|
| 14 |
-
frameworks:
|
| 15 |
-
- pytorch
|
| 16 |
-
- tensorflow
|
| 17 |
-
---
|
| 18 |
-
|
| 19 |
<p align="center">
|
| 20 |
<img src="./assets/okto_logo.png" alt="OktoScript Banner" width="50%" />
|
| 21 |
</p>
|
|
@@ -63,7 +45,7 @@ frameworks:
|
|
| 63 |
8. [Training Pipeline](#-training-pipeline)
|
| 64 |
9. [OktoSeek Internal Formats](#-oktoseek-internal-formats)
|
| 65 |
10. [Integration Targets](#οΈ-integration-targets)
|
| 66 |
-
11. [VS Code Extension](#-vs-code-extension
|
| 67 |
12. [Documentation](#-documentation)
|
| 68 |
13. [FAQ](#-frequently-asked-questions-faq)
|
| 69 |
14. [License](#-license)
|
|
@@ -75,10 +57,11 @@ frameworks:
|
|
| 75 |
|
| 76 |
**New to OktoScript?** Get started in 5 minutes:
|
| 77 |
|
| 78 |
-
1. **
|
| 79 |
-
2. **
|
| 80 |
-
3. **
|
| 81 |
-
4. **
|
|
|
|
| 82 |
|
| 83 |
π **Full documentation:** [`docs/grammar.md`](./docs/grammar.md)
|
| 84 |
π **Validation rules:** [`VALIDATION_RULES.md`](./VALIDATION_RULES.md)
|
|
@@ -117,7 +100,7 @@ OktoScript is the official language of the OktoSeek ecosystem and is used by:
|
|
| 117 |
- π― **OktoSeek IDE** β Visual AI development and experimentation
|
| 118 |
- βοΈ **OktoEngine** β Core execution and decision engine
|
| 119 |
- π **OktoScript Web Editor** β Online editor with syntax validation and autocomplete ([Try it now β](https://oktoseek.com/editor.php))
|
| 120 |
-
- π **VS Code Extension** β Code
|
| 121 |
- π **Autonomous pipelines** β Training, control, evaluation and inference
|
| 122 |
- π€ **AI agents** β Controlled, monitored intelligent systems
|
| 123 |
- π± **Flutter / API deployments** β Cross-platform model integration
|
|
@@ -666,15 +649,46 @@ See [`/examples/`](./examples/) for examples using different export formats.
|
|
| 666 |
|
| 667 |
---
|
| 668 |
|
| 669 |
-
## π¦ VS Code Extension
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 670 |
|
| 671 |
-
-
|
| 672 |
-
-
|
| 673 |
-
-
|
| 674 |
-
-
|
| 675 |
-
-
|
| 676 |
|
| 677 |
-
> π‘ **Tip:**
|
| 678 |
|
| 679 |
---
|
| 680 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
<p align="center">
|
| 2 |
<img src="./assets/okto_logo.png" alt="OktoScript Banner" width="50%" />
|
| 3 |
</p>
|
|
|
|
| 45 |
8. [Training Pipeline](#-training-pipeline)
|
| 46 |
9. [OktoSeek Internal Formats](#-oktoseek-internal-formats)
|
| 47 |
10. [Integration Targets](#οΈ-integration-targets)
|
| 48 |
+
11. [VS Code Extension](#-vs-code-extension)
|
| 49 |
12. [Documentation](#-documentation)
|
| 50 |
13. [FAQ](#-frequently-asked-questions-faq)
|
| 51 |
14. [License](#-license)
|
|
|
|
| 57 |
|
| 58 |
**New to OktoScript?** Get started in 5 minutes:
|
| 59 |
|
| 60 |
+
1. **Install VS Code Extension:** [Install OktoScript Extension](https://marketplace.visualstudio.com/items?itemName=OktoSeekAI.oktoscript) (recommended for best experience)
|
| 61 |
+
2. **Read the guide:** [`docs/GETTING_STARTED.md`](./docs/GETTING_STARTED.md)
|
| 62 |
+
3. **Try an example:** [`examples/basic.okt`](./examples/basic.okt)
|
| 63 |
+
4. **Validate:** `okto validate examples/basic.okt`
|
| 64 |
+
5. **Train:** `okto train examples/basic.okt`
|
| 65 |
|
| 66 |
π **Full documentation:** [`docs/grammar.md`](./docs/grammar.md)
|
| 67 |
π **Validation rules:** [`VALIDATION_RULES.md`](./VALIDATION_RULES.md)
|
|
|
|
| 100 |
- π― **OktoSeek IDE** β Visual AI development and experimentation
|
| 101 |
- βοΈ **OktoEngine** β Core execution and decision engine
|
| 102 |
- π **OktoScript Web Editor** β Online editor with syntax validation and autocomplete ([Try it now β](https://oktoseek.com/editor.php))
|
| 103 |
+
- π **VS Code Extension** β Official VS Code extension with syntax highlighting, autocomplete, snippets, and validation ([Install now β](https://marketplace.visualstudio.com/items?itemName=OktoSeekAI.oktoscript))
|
| 104 |
- π **Autonomous pipelines** β Training, control, evaluation and inference
|
| 105 |
- π€ **AI agents** β Controlled, monitored intelligent systems
|
| 106 |
- π± **Flutter / API deployments** β Cross-platform model integration
|
|
|
|
| 649 |
|
| 650 |
---
|
| 651 |
|
| 652 |
+
## π¦ VS Code Extension
|
| 653 |
+
|
| 654 |
+
**Official OktoScript extension for Visual Studio Code is now available!**
|
| 655 |
+
|
| 656 |
+
[](https://marketplace.visualstudio.com/items?itemName=OktoSeekAI.oktoscript)
|
| 657 |
+
|
| 658 |
+
### Features
|
| 659 |
+
|
| 660 |
+
- β¨ **Syntax Highlighting** - Beautiful color-coded OktoScript syntax for all blocks, keywords, and values
|
| 661 |
+
- π **Smart Autocomplete** - Context-aware suggestions based on the current block (ENV, DATASET, MODEL, TRAIN, etc.)
|
| 662 |
+
- π **Code Snippets** - Quick templates for all OktoScript blocks (PROJECT, MODEL, TRAIN, CONTROL, INFERENCE, FT_LORA, etc.)
|
| 663 |
+
- β
**Syntax Validation** - Validate your `.okt` files using OktoEngine directly from VS Code
|
| 664 |
+
- π **Web Editor Integration** - Open files directly in the OktoScript Web Editor with one command
|
| 665 |
+
- π― **Intelligent Suggestions** - Autocomplete triggers automatically on typing or pressing space
|
| 666 |
+
- π **Block Templates** - Selecting a block from autocomplete generates a complete template (e.g., `MODEL { }`)
|
| 667 |
+
|
| 668 |
+
### Installation
|
| 669 |
+
|
| 670 |
+
**From VS Code Marketplace:**
|
| 671 |
+
1. Open VS Code
|
| 672 |
+
2. Press `Ctrl+Shift+X` (or `Cmd+Shift+X` on Mac) to open Extensions
|
| 673 |
+
3. Search for "OktoScript"
|
| 674 |
+
4. Click "Install"
|
| 675 |
+
|
| 676 |
+
**Or use command line:**
|
| 677 |
+
```bash
|
| 678 |
+
code --install-extension OktoSeekAI.oktoscript
|
| 679 |
+
```
|
| 680 |
+
|
| 681 |
+
**Direct Link:** [Install OktoScript Extension](https://marketplace.visualstudio.com/items?itemName=OktoSeekAI.oktoscript)
|
| 682 |
+
|
| 683 |
+
### Usage
|
| 684 |
|
| 685 |
+
- **Syntax Highlighting:** Open any `.okt` file and enjoy beautiful syntax highlighting
|
| 686 |
+
- **Autocomplete:** Start typing a block name (e.g., `MODEL`, `TRAIN`) and see contextual suggestions
|
| 687 |
+
- **Snippets:** Type block names and press `Tab` to insert complete templates
|
| 688 |
+
- **Validation:** Press `Ctrl+Shift+P` β "OktoScript: Validate current file" (requires OktoEngine)
|
| 689 |
+
- **Web Editor:** Press `Ctrl+Shift+P` β "OktoScript: Open in Web Editor" (requires OktoEngine)
|
| 690 |
|
| 691 |
+
> π‘ **Tip:** The VS Code extension works seamlessly with the [π OktoScript Web Editor](https://oktoseek.com/editor.php). Both provide context-aware autocomplete, real-time syntax validation, and full integration with OktoEngine via the `okto web` command!
|
| 692 |
|
| 693 |
---
|
| 694 |
|