Skip to content

docs: update references to renamed tools #274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 23, 2024
Merged

docs: update references to renamed tools #274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/docs/03-tools/01-using.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ You can also refer to OpenAPI definition files as though they were GPTScript too
GPTScript tools can be packaged and shared on GitHub, and referred to by their GitHub URL. For example:

```yaml
tools: github.com/gptscript-ai/image-generation, github.com/gptscript-ai/vision, sys.read
tools: github.com/gptscript-ai/dalle-image-generation, github.com/gptscript-ai/gpt4-v-vision, sys.read

Generate an image of a city skyline at night and write the resulting image to a file called city_skyline.png.

Expand Down
12 changes: 6 additions & 6 deletions docs/docs/03-tools/02-authoring.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Get the contents of https://github.com
GPTScript is designed to easily export and import tools. Doing this is currently based entirely around the use of GitHub repositories. You can export a tool by creating a GitHub repository and ensureing you have the `tool.gpt` file in the root of the repository. You can then import the tool into a GPTScript by specifying the URL of the repository in the `tools` section of the script. For example, we can leverage the `image-generation` tool by adding the following line to a GPTScript:

```yaml
tools: github.com/gptscript-ai/image-generation
tools: github.com/gptscript-ai/dalle-image-generation

Generate an image of a city skyline at night.
```
Expand All @@ -71,11 +71,11 @@ Generate an image of a city skyline at night.

GPTScript can execute any binary that you ask it to. However, it can also manage the installation of a language runtime and dependencies for you. Currently this is only supported for a few languages. Here are the supported languages and examples of tools written in those languages:

| Language | Example |
|----------|---------|
| `Python` | [Image Generation](https://github.com/gptscript-ai/image-generation) - Generate images based on a prompt |
| `Node.js` | [Vision](https://github.com/gptscript-ai/vision) - Analyze and interpret images |
| `Golang` | [Search](https://github.com/gptscript-ai/search) - Use various providers to search the internet |
| Language | Example |
|----------|----------------------------------------------------------------------------------------------------------------|
| `Python` | [Image Generation](https://github.com/gptscript-ai/dalle-image-generation) - Generate images based on a prompt |
| `Node.js` | [Vision](https://github.com/gptscript-ai/gpt4-v-vision) - Analyze and interpret images |
| `Golang` | [Search](https://github.com/gptscript-ai/search) - Use various providers to search the internet |


### Automatic Documentation
Expand Down
2 changes: 1 addition & 1 deletion examples/recipegenerator/recipegenerator.gpt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
tools: sys.find, sys.read, sys.write, recipegenerator, github.com/gptscript-ai/vision
tools: sys.find, sys.read, sys.write, recipegenerator, github.com/gptscript-ai/gpt4-v-vision

Perform the following steps in order:

Expand Down
2 changes: 1 addition & 1 deletion pkg/repos/get_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ func TestManager_GetContext(t *testing.T) {
Source: types.ToolSource{
Repo: &types.Repo{
VCS: "git",
Root: "https://github.com/gptscript-ai/image-generation.git",
Root: "https://github.com/gptscript-ai/dalle-image-generation.git",
Revision: "b9d9ed60c25da7c0e01d504a7219d1c6e460fe80",
},
},
Expand Down
4 changes: 2 additions & 2 deletions pkg/repos/git/git_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ var (

func TestFetch(t *testing.T) {
err := Fetch(context.Background(), testCacheHome,
"https://github.com/gptscript-ai/image-generation.git",
"https://github.com/gptscript-ai/dalle-image-generation.git",
testCommit)
require.NoError(t, err)
}
Expand All @@ -28,7 +28,7 @@ func TestCheckout(t *testing.T) {
err := os.RemoveAll(commitDir)
require.NoError(t, err)
err = Checkout(context.Background(), testCacheHome,
"https://github.com/gptscript-ai/image-generation.git",
"https://github.com/gptscript-ai/dalle-image-generation.git",
testCommit, commitDir)
require.NoError(t, err)
}