Skip to content

Commit

Permalink
[website] improved doc sections
Browse files Browse the repository at this point in the history
  • Loading branch information
javierluraschi committed Dec 28, 2024
1 parent 16b8a12 commit 8bed595
Show file tree
Hide file tree
Showing 14 changed files with 47 additions and 49 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@
[![Hal9 PyPi Downloads](https://img.shields.io/pypi/dm/hal9?label=PyPI)](https://pypistats.org/packages/hal9)
[![GitHub star chart](https://img.shields.io/github/stars/hal9ai/hal9?style=flat-square)](https://star-history.com/#hal9ai/hal9)

Hal9 is a deployment platform purpose-built for generative AI, enabling you to create and deploy generative ([LLMs](https://github.com/Hannibal046/Awesome-LLM) and [diffusers](https://github.com/huggingface/diffusers)) applications (chatbots, agents, APIs, apps) in seconds.
Hal9 is a deployment platform purpose-built for generative AI, enabling you to create and deploy generative ([LLMs](https://github.com/Hannibal046/Awesome-LLM) and [diffusers](https://github.com/huggingface/diffusers)) applications (chatbots, agents, APIs, and apps). Key features:
- **Flexible:** Use any library ([LangChain](https://python.langchain.com/v0.1/docs/get_started/quickstart/), [DSPy](https://dspy-docs.vercel.app/docs/quick-start/installation)), and any model ([OpenAI](https://platform.openai.com/docs/api-reference/introduction), [Llama](https://ai.meta.com/blog/5-steps-to-getting-started-with-llama-2/), [Groq](https://docs.api.groq.com/md/tutorials/python.groqapi.html), [MidJourney](https://docs.imagineapi.dev/en)).
- **Intuitive:** No need to learn app frameworks ([Flask](https://flask.palletsprojects.com/en/3.0.x/quickstart/)), simply use `input()` and `print()`, or write file to disk.
- **Scalable:** Designed to integrate your app with scalable technologies ([Docker](https://www.docker.com/), [Kubernetes](https://kubernetes.io/), etc).
- **Powerful:** Using an OS process (stdin, stdout, files) as our app contract, enables long-running agents, multiple programming languages, complex system dependencies, and running arbitrary code in a secure Kubernetes pod.
- **Powerful:** Support for long-running agents, multiple programming languages, complex system dependencies, and running arbitrary code in a secure Kubernetes pods.
- **Open:** The code behind [hal9](https://hal9.com/apps/hal9), is also open source and open for contributions under at [apps/hal9](https://github.com/hal9ai/hal9/tree/main/apps/hal9).

Focus on AI (RAG, fine-tuning, alignment, training) and skip engineering tasks (frontend development, backend integration, deployment, operations).

## Getting started
## Getting Started

Create and share a chatbot in seconds as follows:

Expand Down
2 changes: 1 addition & 1 deletion javascript/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "hal9",
"version": "2.1.2",
"license": "MIT",
"description": "Hal9: Create and Share Generative Apps",
"description": "Hal9: Create and Share Powerful AIs",
"main": "dist/hal9.js",
"repository": "https://github.com/hal9ai/hal9",
"author": "Hal9 Inc",
Expand Down
14 changes: 5 additions & 9 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ import {themes as prismThemes} from 'prism-react-renderer';

/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'Hal9: Create AI Coworkers',
tagline: 'Hal9 provides enterprise-ready, secure, customizable, model-agnostic AI coworkers powered by the best AI libraries.',
title: 'Hal9: Create and Share Powerful AIs',
tagline: 'Hal9 provides enterprise-ready, secure, customizable, model-agnostic AIs powered by the best AI libraries.',
favicon: 'img/favicon.ico',
url: 'https://hal9.com',
baseUrl: '/docs/',
Expand Down Expand Up @@ -91,15 +91,11 @@ const config = {
position: 'left',
},
*/
{
type: 'docSidebar',
sidebarId: 'tutorialSidebar',
position: 'left',
label: 'Learn',
},
{ to: '/learn/hal9', label: 'Users', position: 'left' },
{ to: '/learn/code', label: 'Developers', position: 'left' },
{ to: '/learn/genai', label: 'Concepts', position: 'left' },
{ to: '/reference/code', label: 'Reference', position: 'left' },
{ to: '/blog', label: 'Blog', position: 'left' },
{ to: 'https://hal9.com/news', label: 'News', position: 'left' },
{
href: 'https://github.com/hal9ai/hal9',
className: 'github-link',
Expand Down
2 changes: 1 addition & 1 deletion website/learn/code/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 2
---

# Building Coworkers
# Building AIs

ChatGPT popularized the chat interface as the application interface to interoperate with [LLMs](../genai/llm), tools like MidJourney have also popularized through their use of Discord.

Expand Down
6 changes: 3 additions & 3 deletions website/learn/code/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@
[![Hal9 PyPi Downloads](https://img.shields.io/pypi/dm/hal9?label=PyPI)](https://pypistats.org/packages/hal9)
[![GitHub star chart](https://img.shields.io/github/stars/hal9ai/hal9?style=flat-square)](https://star-history.com/#hal9ai/hal9)

Hal9 is a deployment platform purpose-built for generative AI, enabling you to create and deploy generative ([LLMs](https://github.com/Hannibal046/Awesome-LLM) and [diffusers](https://github.com/huggingface/diffusers)) applications (chatbots, agents, APIs, apps) in seconds.
Hal9 is a deployment platform purpose-built for generative AI, enabling you to create and deploy generative ([LLMs](https://github.com/Hannibal046/Awesome-LLM) and [diffusers](https://github.com/huggingface/diffusers)) applications (chatbots, agents, APIs, and apps). Key features:
- **Flexible:** Use any library ([LangChain](https://python.langchain.com/v0.1/docs/get_started/quickstart/), [DSPy](https://dspy-docs.vercel.app/docs/quick-start/installation)), and any model ([OpenAI](https://platform.openai.com/docs/api-reference/introduction), [Llama](https://ai.meta.com/blog/5-steps-to-getting-started-with-llama-2/), [Groq](https://docs.api.groq.com/md/tutorials/python.groqapi.html), [MidJourney](https://docs.imagineapi.dev/en)).
- **Intuitive:** No need to learn app frameworks ([Flask](https://flask.palletsprojects.com/en/3.0.x/quickstart/)), simply use `input()` and `print()`, or write file to disk.
- **Scalable:** Designed to integrate your app with scalable technologies ([Docker](https://www.docker.com/), [Kubernetes](https://kubernetes.io/), etc).
- **Powerful:** Using an OS process (stdin, stdout, files) as our app contract, enables long-running agents, multiple programming languages, complex system dependencies, and running arbitrary code in a secure Kubernetes pod.
- **Powerful:** Support for long-running agents, multiple programming languages, complex system dependencies, and running arbitrary code in a secure Kubernetes pods.
- **Open:** The code behind [hal9](https://hal9.com/apps/hal9), is also open source and open for contributions under at [apps/hal9](https://github.com/hal9ai/hal9/tree/main/apps/hal9).

Focus on AI (RAG, fine-tuning, alignment, training) and skip engineering tasks (frontend development, backend integration, deployment, operations).

## Getting started
## Getting Started

Create and share a chatbot in seconds as follows:

Expand Down
2 changes: 1 addition & 1 deletion website/learn/code/llms.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ completion = OpenAI().chat.completions.create(
print(completion.choices[0].message.content)
```

However, the previous code will forget messages and take too long to display an answer. We can improve this using the memory and streaming concepts from the [building coworkers](create.md) section:
However, the previous code will forget messages and take too long to display an answer. We can improve this using the memory and streaming concepts from the [building AIs](create.md) section:

```python
import hal9 as h9
Expand Down
12 changes: 6 additions & 6 deletions website/learn/hal9/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ sidebar_position: 3

import ThemedImage from '../../src/components/themedimg.jsx'

# Creating Coworkers
# Creating AIs

You can create a coworker with Hal9 in just a few seconds. The first step is to use the sidebar and click "create".
You can create an AI with Hal9 in just a few seconds. The first step is to use the sidebar and click "create".

<center><a href="/create"><ThemedImage src="hal9-create" /></a></center>

Expand All @@ -20,28 +20,28 @@ The name defines the title for your chatbot and also the URL path used to access

## Description

The description field services two purposes. First, it is used when browsing additional details for your chatbot. Secondly, some templates use the description to customize the experience and the behavior of your coworkers.
The description field services two purposes. First, it is used when browsing additional details for your chatbot. Secondly, some templates use the description to customize the experience and the behavior of your AIs.

For example, the description field might be used as the system prompt in some cases, see also [prompts](../genai/prompts) concept section.

<center><a href="/create"><ThemedImage src="hal9-create-description" /></a></center>

## Data

Optionally, you can upload additional data to your AI coworker. A very common use case is to attach a document in the form of a PDF that can be used to extract additional context to answer questions. You can also attach numerical data in the form of spreadsheets in CSV or Excel files. For large datasets, you can connect a database with all the information needed to answer data questions.
Optionally, you can upload additional data to your AI. A very common use case is to attach a document in the form of a PDF that can be used to extract additional context to answer questions. You can also attach numerical data in the form of spreadsheets in CSV or Excel files. For large datasets, you can connect a database with all the information needed to answer data questions.

<center><a href="/create"><ThemedImage src="hal9-create-data" /></a></center>

## Welcome Message

The welcome message for your AI coworker can be customized. This is a great opportunity to set the tone of the conversation and give the user hints as to what to ask or how to interact with your AI coworker.
The welcome message for your AI can be customized. This is a great opportunity to set the tone of the conversation and give the user hints as to what to ask or how to interact with your AI.

For example, you might want to explicitly state what you are knowledgeable for: "Hello, I can answer revenue related questions." or start collecting important information like: "What questions can I answer from this website?".

<center><a href="/create"><ThemedImage src="hal9-create-message" /></a></center>

## Create

Once you click the "create" button, your AI coworker will be created. By default, the access will be private, accessible to only your account. Later on, we will explore how to share your AI coworker.
Once you click the "create" button, your AI will be created. By default, the access will be private, accessible to only your account. Later on, we will explore how to share your AI.

<center><a href="/create"><ThemedImage src="hal9-create-create" /></a></center>
8 changes: 4 additions & 4 deletions website/learn/hal9/explore.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ sidebar_position: 1

import ThemedImage from '../../src/components/themedimg.jsx'

# Exploring Coworkers
# Exploring AIs

There are several community examples you can use at work or use as inspiration to create your own. To explore them, use the sidebar "explore" tab.

<center><a href="/explore"><ThemedImage src="hal9-explore" /></a></center>

## Hal9 AI Coworker
## Hal9 AI

We recommend trying first the Hal9 AI Coworker which was created by the Hal9 team and showcases many features you may want to replicate in your own AI coworkers.
We recommend trying first the Hal9 AI which was created by the Hal9 team and showcases many features you may want to replicate in your own AIs.

<center><a href="/explore"><ThemedImage src="hal9-explore-hal9" /></a></center>

Expand All @@ -25,4 +25,4 @@ Some of the features this chatbot supports includes:
- Understanding documents.
- Answering questions about Hal9.

The code for Hal9's AI coworker is open-source under an MIT license and available for your technical team, see [github.com/hal9ai/hal9/tree/main/apps/hal9](https://github.com/hal9ai/hal9/tree/main/apps/hal9).
The code for Hal9's AI is open-source under an MIT license and available for your technical team, see [github.com/hal9ai/hal9/tree/main/apps/hal9](https://github.com/hal9ai/hal9/tree/main/apps/hal9).
14 changes: 8 additions & 6 deletions website/learn/hal9/index.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
import ThemedImage from '../../src/components/themedimg.jsx'

# Hal9: Create and Share AI Coworkers
# Hal9: Create and Share Powerful AIs

Hal9 is a platform to effortlessly create and share AI coworkers. As opposed to chatbots, AI coworkers are productivity-focused chatbots that go beyond generic information available in services like ChatGPT, Gemini, Claude and the like.
Hal9 is a platform designed to simplify the creation and sharing of powerful AIs. Unlike traditional chatbots, Hal9 enables you to go beyond basic chat interfaces and the generic capabilities offered by services like ChatGPT, Gemini, or Claude.

An AI coworker is able to connect to private enterprise datasets, integrate to enterprise communication services, build enterprise applications, and is extensible by developers with powerful open-source libraries. Therefore, AI coworkers must run securely in your own cloud to prevent sharing any private resources with anyone, including Hal9.
While your AI can include a chat interface when needed, it can also take other forms, such as APIs or applications for tasks like image uploads, providing unmatched flexibility.

Hal9's user interface is a web application that showcases the main use cases on its sidebar to explore existing coworkers, create new coworkers, share coworkers and integrate them with communication tools like Slack.
With Hal9, your AI can securely connect to private enterprise datasets, integrate seamlessly with enterprise communication tools, build robust applications, and leverage powerful open-source libraries for customization. To ensure data security, your AI operates exclusively within your own cloud environment, eliminating the risk of exposing private resources—even to Hal9 itself.

The Hal9 interface is a user-friendly web application. Its intuitive sidebar allows you to explore existing AIs, create new ones, share your work, and integrate AIs with tools like Slack, making it easy to bring your ideas to life and streamline communication workflows.

<center><a href="explore"><ThemedImage src="hal9-start" /></a></center>

Hal9's developer interface consists of a powerful open-source library which enables developers to build AI coworkers of arbitrary complexity. Developers can write and modify code from Hal9's user interface or deploy from other developer services like GitHub.
Hal9's developer interface offers a robust open-source library, allowing developers to build AIs of any complexity. Developers can write and modify code directly within Hal9s user interface or deploy from external services like GitHub.

This enables business users to rapidly create AI coworkers and for developers to enhance them with arbitrary complexity that fulfills the business user needs.
This flexibility empowers business users to quickly create AIs tailored to their needs, while developers can easily enhance and scale these AIs with advanced features, ensuring they meet the specific requirements of the business.
14 changes: 7 additions & 7 deletions website/learn/hal9/using.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@ sidebar_position: 2

import ThemedImage from '../../src/components/themedimg.jsx'

# Using Coworkers
# Using AIs

The most common interface to interact with your AI coworker is through a chat session. This chat session opens by default whenever you open an AI coworker in Hal9.
The most common interface to interact with your AI is through a chat session. This chat session opens by default whenever you open an AI in Hal9.

Notice that AI coworkers will greet you with a customized message chosen by the author of the AI coworker.
Notice that AIs will greet you with a customized message chosen by the author of the AI.

<center><a href="/apps/hal9"><ThemedImage src="hal9-chat-welcome" /></a></center>

## Prompt Input

You can input prompts (send messages) to your AI coworker using the bottom textbox from the chat interface. The nature of the inputs are dependent on what kind of AI coworker you are using.
You can input prompts (send messages) to your AI using the bottom textbox from the chat interface. The nature of the inputs are dependent on what kind of AIs you are using.

Hal9's AI Coworker supports a broad range of tasks from answering generic questions, to generating images and processing documents and numerical datasets. However, other ones might be specialized in specific tasks or data sources.
Hal9's AI supports a broad range of tasks from answering generic questions, to generating images and processing documents and numerical datasets. However, other ones might be specialized in specific tasks or data sources.

<center><a href="/apps/hal9"><ThemedImage src="hal9-chat-textarea" /></a></center>

Expand All @@ -28,13 +28,13 @@ You can submit prompts by hitting enter, or by clicking the "submit" buttom in t

## User Messages

Messages you send are aligned to the right side of the chat interface. Once a user message is submitted, the prompt input area will be disabled until the AI coworker finishes processing the submitted message.
Messages you send are aligned to the right side of the chat interface. Once a user message is submitted, the prompt input area will be disabled until the AI finishes processing the submitted message.

<center><a href="/apps/hal9"><ThemedImage src="hal9-chat-user" /></a></center>

## AI Messages

AI coworker messages are aligned to the left side of the chat interface. Just like messaging people in communication channels, AI coworkers will take different time to reply to messages. Some coworkers that are answering generic questions can answer almost instantaneously, coworkers that process large amounts of data tend to take longer, coworkers that answer complex questions can take even longer times.
AI messages are aligned to the left side of the chat interface. Just like messaging people in communication channels, AIs will take different time to reply to messages. Some that are answering generic questions can answer almost instantaneously, AIs that process large amounts of data tend to take longer, AIs that answer complex questions can take even longer times.

For example, one could ask "Is the world flat?" and expect a fast reply, compared to the question "Please calculate as many digits of Pi as you can" would likely take too long or potentially never end.

Expand Down
4 changes: 2 additions & 2 deletions website/screenshots/screenshots.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ const actions = [
{ query: '.driver-popover-next-btn', screenshot: 'hal9-create-message', waitfor: '#create-welcome'},
{ query: '.driver-popover-next-btn', screenshot: 'hal9-create-create', waitfor: '#create-create'},

// Coworkers
{ query: '.driver-popover-next-btn', screenshot: 'hal9-coworkers', waitfor: '#sidebar-coworkers'},
// AIs
{ query: '.driver-popover-next-btn', screenshot: 'hal9-ais', waitfor: '#sidebar-ais'},
];

async function performActions(page, actions, suffix) {
Expand Down
Loading

0 comments on commit 8bed595

Please sign in to comment.