Skip to content

Commit

Permalink
Tj202/readme and doc update (#76)
Browse files Browse the repository at this point in the history
  • Loading branch information
TJ202 authored Feb 17, 2025
1 parent 777cdde commit 5e89c00
Show file tree
Hide file tree
Showing 7 changed files with 17 additions and 24 deletions.
1 change: 0 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ install-agentc-pip:
@echo "This may take some time..."
conda run -n $(or $(env_name),agentc_env) bash -c "\
pip install $(AGENT_CATALOG_LIBS)/agentc && \
pip install $(AGENT_CATALOG_LIBS)/agentc_langchain && \
echo '' && \
echo '----Verifying Installation----' && \
pip list | grep agentc && \
Expand Down
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,6 @@ The mono-repo for the Couchbase Agent Catalog project.
pip install libs/agentc
```

If you are interested in developing with langchain, also install `agentc_langchain` by running the following:

```bash
pip install libs/agentc_langchain
```

If you are interested in building a ``.whl`` file (for later use in ``.whl``-based installs), use :command:`poetry`
directly:

Expand Down Expand Up @@ -178,8 +172,10 @@ For more guide on how to use `.agentcignore` file check the [documentation](http

## Docs and Templates

Refer to [`docs/`](docs) to explore templates and other references while writing your agent workflow with Couchbase
Agent Catalog. We also provide some starter [`recipes`](templates) if you are building an agent from scratch.
Refer to [`docs/`](docs) to build the [sphinx documentation](https://couchbaselabs.github.io/agent-catalog/index.html) and explore Couchbase Agent Catalog usage before writing your agent workflow.
We also provide some starter [`agents`](templates/agents) using different frameworks to understand the flow better.

For more info on basic tool and prompt definitions, please refer to the [`tool`](templates/tools) and [`prompt`](templates/prompts) templates that can be created using `agentc add` command.

## For Contributors / Developers

Expand Down
19 changes: 11 additions & 8 deletions docs/source/guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The Agent Catalog package is not just a tool/prompt catalog, it's a foundation f
development.
Agent builders will follow this workflow:

1. **Sample Downloading**: Download the starter agent from the :file:`templates/starter_agent` directory.
1. **Sample Downloading**: Download the starter agent from the :file:`templates/agents` directory.

2. **Agent Building**: The sample agent is meant to be a reference for building your own agents.
You will need to modify the agent to fit your use case.
Expand Down Expand Up @@ -139,7 +139,13 @@ Agent analysts will follow this workflow:

2. **Log Transformations**: For users with Couchbase Analytics enabled, we provide the following views (expressed as
Couchbase Analytics Views) to help you get started with conversational-based agents.
All Views below belong to the scope :file:`agent_activity`.
All Views belong to the scope :file:`agent_activity` and can be queried using the Analytics service by executing the following query:

.. code-block:: sql
SELECT logs_view.* FROM `[[MY_BUCKET]]`.agent_activity.[VIEW_NAME] AS logs_view;
Following are the type of Views available to explore:

.. admonition:: Sessions ``(sid, start_t, vid, msgs)``

Expand All @@ -160,7 +166,7 @@ Agent analysts will follow this workflow:

.. code-block:: sql
WHERE sid = [[MY_BUCKET]].agent_activity.LastSession()
WHERE sid = `[[MY_BUCKET]]`.agent_activity.LastSession
.. admonition:: Exchanges ``(sid, question, answer, walk)``

Expand Down Expand Up @@ -230,15 +236,12 @@ Ignoring Files While Indexing
-----------------------------

When indexing tools and prompts, you may want to ignore certain files.

By default the :file:`index` command will ignore files/patterns present in :file:`.gitignore` file.

In addition to :file:`.gitignore`, there might be situation where additional files have to be ignored by agentc and not git.
To add such files/patterns :file:`.agentcignore` file can be used similar to :file:`.gitignore`.

For example,

If the project structure is as below:
For example, if the project structure is as below:

.. code-block:: text
Expand All @@ -262,7 +265,7 @@ If the project structure is as below:

While indexing using the command :command:`agentc index --tools src`, :file:`src/agent.py` will be indexed along with the tools present in the :file:`src` directory.

Inorder to avoid that :file:`.agentcignore` file can be added in :file:`src` directory with the following content to avoid indexing the file containing agent code:
Inorder to avoid that, :file:`.agentcignore` file can be added in :file:`src` directory with the following content to avoid indexing the file containing agent code:

.. code-block:: text
Expand Down
3 changes: 2 additions & 1 deletion docs/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,8 @@ Building From Source (with pip)
# Install the agentc package.
pip install libs/agentc
If you are interested in developing with langchain, also install ``agentc_langchain`` by running the following:
If you are interested in building a ``.whl`` file (for later use in ``.whl``-based installs), use :command:`poetry`
directly:

.. code-block:: bash
Expand Down
4 changes: 0 additions & 4 deletions libs/agentc/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ develop = true
[tool.poetry.dependencies.agentc-langchain]
path = "../agentc_langchain"
develop = true
optional = true

[tool.poetry.group.dev.dependencies]
pre-commit = "^3.2.2"
Expand All @@ -45,9 +44,6 @@ pytest = "^8.3.2"
path = "../agentc_testing"
develop = true

[tool.poetry.extras]
langchain = ["agentc-langchain"]

[tool.pytest.ini_options]
markers = [
"smoke: marks tests for running on each git-push",
Expand Down
1 change: 0 additions & 1 deletion templates/agents/with_controlflow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,6 @@ This directory contains a starter project for building agents with Couchbase, Co
Alternatively, install the example using `pip`
```bash
pip install ../../../libs/agentc
pip install ../../../libs/agentc_langchain
pip install -r requirements.txt
```

Expand Down
1 change: 0 additions & 1 deletion templates/agents/with_langgraph/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,6 @@ This directory contains a starter project for building agents with Couchbase, La
Alternatively, install the example using `pip`
```bash
pip install ../../../libs/agentc
pip install ../../../libs/agentc_langchain
```

7. Run `agentc` to make sure this project has installed correctly (note that your first run will take a couple of
Expand Down

0 comments on commit 5e89c00

Please # to comment.