Skip to content

Commit

Permalink
docs: general name change from astra to ten agent (#9)
Browse files Browse the repository at this point in the history
* Changed the name from Astra to TEN Agent, including repo name.
* Changed the folder structure, getting started to TEN Agent
* Fixed the tman command in how to create extension.
* Removed the unnecessary command in tman installation.

Co-authored-by: Hu Yueh-Wei <[email protected]>
  • Loading branch information
cyfyifanchen and halajohn authored Sep 12, 2024
1 parent c7da5d3 commit f0e7757
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 21 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The TEN framework offers the following advantages:

## Use Cases

With the TEN framework, you can easily accomplish the following scenarios. You can see actual demos at [TEN Agent](https://github.com/TEN-framework/ASTRA.ai):
With the TEN framework, you can easily accomplish the following scenarios. You can see actual demos at [TEN Agent](https://github.com/TEN-framework/TEN-Agent):

1. Simultaneous interpretation
2. Speech-to-text conversion
Expand Down
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Here, you’ll get an overview of all the incredible features TEN offers to help

Before we get started, please click the [**star button on our GitHub repo**](https://github.com/TEN-framework/ten_framework) to stay updated with TEN.

TEN’s capabilities are immense, and we’ve harnessed its power to create a real-time multimodal agent that we actively maintain and support. You can explore this agent in our dedicated repository of [ **Astra Agent** ](https://github.com/ten-framework/astra.ai) We’d love to have your support, don’t forget to give it a star as well!
TEN’s capabilities are immense, and we’ve harnessed its power to create a real-time multimodal agent that we actively maintain and support. You can explore this agent in our dedicated repository of [ **TEN Agent** ](https://github.com/ten-framework/TEN-Agent) We’d love to have your support, don’t forget to give it a star as well!


<figure><img src="assets/gif/star_the_repo_confetti.gif" alt=""><figcaption><p>Star us to stay updated with Astra Agent</p></figcaption></figure>
<figure><img src="assets/gif/star_the_repo_confetti.gif" alt=""><figcaption><p>Star us to stay updated with TEN Agent</p></figcaption></figure>
10 changes: 5 additions & 5 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@
* [Key Concepts](vision/key_concepts.md)
* [Scenarios](vision/application_scenarios.md)

## Getting Started with Astra
## TEN Agent

* [Quickstart](getting_started/quickstart.md)
* [Customize Agent](getting_started/customize_your_agent.md)
* [Create a Hello World Extension](getting_started/create_a_hello_world_extension.md)
* [Setup VSCode Inside Container](getting_started/setting_up_vscode_for_development_inside_container.md)
* [Getting Started](ten_agent/getting_started.md)
* [Customize TEN Agent](ten_agent/customize_your_agent.md)
* [Create a Hello World Extension](ten_agent/create_a_hello_world_extension.md)
* [Setup VSCode Inside Container](ten_agent/setting_up_vscode_for_development_inside_container.md)

## TEN framework

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,11 @@ astra_playground | ✓ Ready in 293ms

Now, we’ve got the following services running:

`astra_agents_dev` at `http://0.0.0.0:49483` (the backend server for the Graph Designer)
`astra_agents_dev` at `http://0.0.0.0:49483` (the backend server)

`astra_graph_designer` at `http://localhost:3000` (the UI of the Graph Designer)
`astra_playground` at `http://localhost:3000` (the frontend of TEN Agent)

`astra_playground` at `http://localhost:3001` (the UI of the Astra agent)
`astra_graph_designer` at `http://localhost:3001` (the frontend of Graph Designer)

## 2. Enter the docker container

Expand All @@ -84,29 +84,26 @@ By running the following commands, an extension called `hello_world` will be cre

{% tabs %}
{% tab title="Python" %}
<pre class="language-bash" data-title=">_ Bash" data-overflow="wrap"><code class="lang-bash">cd agents/ten_packages/extension
<pre class="language-bash" data-title=">_ Bash" data-overflow="wrap"><code class="lang-bash">cd agents

<strong>tman install extension default_extension_python --template-mode --template-data package_name=hello_world --template-data class_name_prefix=HelloWorld
</strong>
cd /app
</code></pre>
{% endtab %}

{% tab title="Go" %}
<pre class="language-bash" data-title=">_ Bash" data-overflow="wrap"><code class="lang-bash">cd agents/ten_packages/extension
<pre class="language-bash" data-title=">_ Bash" data-overflow="wrap"><code class="lang-bash">cd agents

<strong>tman install extension default_extension_go --template-mode --template-data package_name=hello_world --template-data class_name_prefix=HelloWorld
</strong>
cd /app
</code></pre>
{% endtab %}

{% tab title="C++" %}
<pre class="language-bash" data-title=">_ Bash" data-overflow="wrap"><code class="lang-bash">cd agents/ten_packages/extension
<pre class="language-bash" data-title=">_ Bash" data-overflow="wrap"><code class="lang-bash">cd agents

<strong>tman install extension default_extension_cpp --template-mode --template-data package_name=hello_world --template-data class_name_prefix=HelloWorld
</strong>
cd /app
</code></pre>
{% endtab %}
{% endtabs %}
Expand Down Expand Up @@ -158,8 +155,6 @@ Navigate into the `hello_world` directory and open manifest.json. Add the API ob
}
</code></pre>

For detailed information on the API and schema, please refer to [ten_api_beta.md](../ten_service/ten_api_beta.md "mention") and [ten_schema_beta.md](../ten_service/ten_schema_beta.md "mention").

## 5. Build the extension

Let's use `cd /app` command to go back to the root of the project, and run `make build` to build the extension.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,6 @@ layout:

<figure><img src="../assets/gif/graph_designer.gif" alt=""><figcaption></figcaption></figure>

The Graph Designer is a user-friendly, visual tool that allows you to create and modify the behavior and responses of the Astra agent without needing to write code. This approach is highly recommended for its ease of use and efficiency. By leveraging the Graph Designer, you can quickly design complex interactions and workflows through a graphical interface, making it accessible even for those with limited programming experience.
The Graph Designer is a user-friendly, visual tool that allows you to create and modify the behavior and responses of the Astra agent without needing to write code. This approach is highly recommended for its ease of use and efficiency. By leveraging the Graph Designer, you can quickly design complex interactions and workflows through a graphical interface, making it accessible even for those with limited programming experience.

WIP
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ layout:

# Quickstart

In this chapter, we’ll build the Astra agent together. For additional help, check out the YouTube video tutorial at the end.
In this chapter, we’ll build the TEN Agent together. For additional help, check out the YouTube video tutorial at the end.

<figure><img src="../assets/gif/astra_voice_agent.gif" alt=""><figcaption></figcaption></figure>

Expand Down

0 comments on commit f0e7757

Please sign in to comment.