Skip to content
This repository was archived by the owner on Sep 12, 2024. It is now read-only.

Commit 487f69a

Browse files
authored
Update README, docs (#34)
* Updated README * Minor * Minor
1 parent cf8d585 commit 487f69a

File tree

2 files changed

+12
-26
lines changed

2 files changed

+12
-26
lines changed

README.md

Lines changed: 11 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -11,39 +11,27 @@
1111
<a href="https://twitter.com/TextCortex/"><img src="https://img.shields.io/twitter/url/https/twitter.com/cloudposse.svg?style=social&label=Follow%20%40TextCortex" alt="Twitter"></a>
1212
<br />
1313
<br />
14-
<i>A Python library for <a href="https://en.wikipedia.org/wiki/Soft_computing">soft-code</a> development — program in plain English with AI code generation!</i>
14+
<i>A no-code development framework — Let AI do the coding for you 🦾</i>
1515
</p>
1616
<hr />
1717

1818
tl;dr in goes English, out comes Python:
1919

2020
https://user-images.githubusercontent.com/2453968/199964302-0dbe1d7d-81c9-4244-a9f2-9d959775e471.mp4
2121

22-
ICortex enables you to develop **soft programs**:
22+
ICortex is a no-code development framework that lets you to develop Python programs using plain English. Simply create a recipe that breaks down step-by-step what you want to do in plain English. Our code generating AI will follow your instructions and develop a Python program that suits your needs.
2323

24-
> *Soft program:* a set of instructions (i.e. prompts) [written in natural language](https://en.wikipedia.org/wiki/Natural-language_programming) (e.g. English), processed by a language model that generates code at a lower layer of abstraction (e.g. Python), to perform work more flexibly than regular software.
24+
[Create a TextCortex account](https://app.textcortex.com/user/signup?registration_source=icortex) to receive free starter credits and start using ICortex.
2525

26-
In other words, ICortex is a **natural language programming** (NLP) framework that enables you to write code in English, and then run it in Python. It aims to make programming more accessible to non-programmers.
26+
## Try it out
2727

28-
ICortex is designed to be …
28+
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/textcortex/icortex-binder/HEAD?filepath=basic_example.ipynb)
2929

30-
- a drop-in replacement for the [IPython kernel](https://ipython.org/). Prompts are executed via [magic commands](https://ipython.readthedocs.io/en/stable/interactive/magics.html) such as `%prompt`.
31-
- interactive—automatically install missing packages, decide whether to execute the generated code or not, and so on, directly in the Jupyter Notebook cell.
32-
- open source and fully extensible—ICortex introduces a [domain-specific language](https://en.wikipedia.org/wiki/Domain-specific_language) for orchestrating various code generation services. If you think we are missing a model or an API, you can request it by creating an issue, or implement it yourself by subclassing `ServiceBase` under [`icortex/services`](icortex/services).
30+
You can try out ICortex directly in your browser. Launch a Binder instance by clicking [here](https://mybinder.org/v2/gh/textcortex/icortex-binder/HEAD?filepath=basic_example.ipynb), and follow the [instructions in our docs](https://docs.icortex.ai/en/latest/quickstart.html#using-icortex) to get started.
3331

34-
ICortex is similar to [Github Copilot](https://github.com/features/copilot) but with certain differences that make it stand out:
32+
Alternatively, you can use ICortex in Google Colab if you have an account. See [below](#on-google-colab).
3533

36-
| Feature | GitHub Copilot | ICortex |
37-
|---|:---:|:---:|
38-
| Generates code ... | In the text editor | At runtime through a [Jupyter kernel](https://docs.jupyter.org/en/latest/projects/kernels.html) |
39-
| Control over code generation context ... | No | Yes |
40-
| Natural language instructions are a ... | Second-class citizen (Code comes first) | First-class citizen (Prompts *are* the program) |
41-
| The resulting program is ... | Static | Dynamic—adapts to the context |
42-
| Can connect to different code generation APIs | No | Yes |
43-
44-
The main difference between ICortex and a code-generation plugin like GitHub Copilot is that ICortex is a new paradigm for [Natural Language Programming](https://en.wikipedia.org/wiki/Natural-language_programming) where the *prompt* is the first-class citizen. GitHub Copilot, on the other hand, enhances the existing paradigm that are already used by developers.
45-
46-
ICortex is currently in alpha, so expect breaking changes. We are giving free credits to our first users—[join our Discord](https://discord.textcortex.com/) to request more if you finish the starter credits.
34+
[Check out the documentation](https://docs.icortex.ai/) to learn more. [Join our Discord](https://discord.textcortex.com/) to get help.
4735

4836
## Installation
4937

@@ -66,9 +54,11 @@ python -m icortex.kernel.install
6654
import icortex.init
6755
```
6856

57+
Note that the package needs to be installed to every new Google Colab runtime—you may need to reinstall if it ever gets disconnected.
58+
6959
## Quickstart
7060

71-
[Click here to visit the docs and get started using ICortex](https://icortex.readthedocs.io/en/latest/quickstart.html).
61+
[Click here to get started using ICortex](https://icortex.readthedocs.io/en/latest/quickstart.html).
7262

7363
## Getting help
7464

docs/source/index.rst

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,7 @@ tl;dr in goes English, out comes Python:
1313
.. video:: https://user-images.githubusercontent.com/2453968/199964302-0dbe1d7d-81c9-4244-a9f2-9d959775e471.mp4
1414
:width: 100%
1515

16-
ICortex enables you to develop **soft programs**:
17-
18-
*Soft program:* a set of instructions (i.e. prompts) `written in natural language <https://en.wikipedia.org/wiki/Natural-language_programming>`__ (e.g. English), processed by a language model that generates code at a lower layer of abstraction (e.g. Python), to perform work more flexibly than regular software.
19-
20-
In other words, ICortex is a **natural language programming** (NLP) framework that enables you to write code in English, and then run it in Python. It aims to make programming more accessible to non-programmers.
16+
ICortex is a no-code development framework that lets you to develop Python programs using plain English. Simply create a recipe that breaks down step-by-step what you want to do in plain English. Our code generating AI will follow your instructions and develop a Python program that suits your needs.
2117

2218
ICortex is designed to be …
2319

0 commit comments

Comments
 (0)