Skip to content

Commit

Permalink
fix typo
Browse files Browse the repository at this point in the history
  • Loading branch information
richardsonlima committed Sep 24, 2024
1 parent f4206d4 commit e806397
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 17 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# pyicl Overview
# synapsense Overview

## Demo
![Alt text](ttyrecord.gif)
Expand All @@ -8,9 +8,9 @@ SynapSense is a cutting-edge Python library designed to streamline the implement

In-Context Learning refers to the technique where a model is provided with examples within the context of its input, allowing the model to learn from these examples without the need for explicit fine-tuning. The idea is to leverage contextual examples to influence the model's output dynamically.

The pyicl library offers tools to manage and utilize these contextual examples efficiently, providing a structured way to build prompts and optimize the context provided to the LLM. pyicl is modular, allowing developers to pick and choose components based on their needs.
The synapsense library offers tools to manage and utilize these contextual examples efficiently, providing a structured way to build prompts and optimize the context provided to the LLM. synapsense is modular, allowing developers to pick and choose components based on their needs.

## Components of pyicl
## Components of synapsense

### 1. ContextManager

Expand Down Expand Up @@ -57,18 +57,18 @@ The pyicl library offers tools to manage and utilize these contextual examples e

### 5. IntegrationAPI (Planned)

**Purpose**: The `IntegrationAPI` is meant to facilitate the integration of pyicl with other applications and frameworks, making it easier to use in production environments.
**Purpose**: The `IntegrationAPI` is meant to facilitate the integration of synapsense with other applications and frameworks, making it easier to use in production environments.

**Key Features** (Planned):
- **RESTful API**: Provide a REST API for accessing pyicl components remotely.
- **RESTful API**: Provide a REST API for accessing synapsense components remotely.
- **ML Pipeline Integration**: Seamlessly integrate with machine learning pipelines in frameworks like TensorFlow or PyTorch.
- **Deployment Support**: Tools for deploying pyicl in production environments.
- **Deployment Support**: Tools for deploying synapsense in production environments.

**Usage**: This component would be crucial for teams looking to deploy pyicl in large-scale applications or integrate it with existing systems, enabling more widespread adoption.
**Usage**: This component would be crucial for teams looking to deploy synapsense in large-scale applications or integrate it with existing systems, enabling more widespread adoption.

### 6. UserInterface (Planned)

**Purpose**: The `UserInterface` would provide a graphical interface for interacting with pyicl, making it accessible to non-technical users.
**Purpose**: The `UserInterface` would provide a graphical interface for interacting with synapsense, making it accessible to non-technical users.

**Key Features** (Planned):
- **Context Management UI**: A visual interface to manage contexts and examples.
Expand All @@ -89,10 +89,10 @@ The pyicl library offers tools to manage and utilize these contextual examples e
## Usage
This component is particularly useful in scenarios where the diversity of examples is critical, such as in adversarial settings or when working with limited data.

Here is a simple example of how to use pyicl:
Here is a simple example of how to use synapsense:

```python
from pyicl import ContextManager, PromptBuilder
from synapsense import ContextManager, PromptBuilder

context_manager = ContextManager()
prompt_builder = PromptBuilder(context_manager)
Expand Down Expand Up @@ -151,4 +151,4 @@ With this initial structure, you can start building on top of it, integrating mo
## Summary
pyicl is designed to provide a structured and modular approach to managing context in applications that utilize Large Language Models. By offering tools to manage, build, optimize, and experiment with contextual examples, pyicl aims to make In-Context Learning more accessible and effective, allowing users to maximize the potential of LLMs in various use cases. The planned components, such as ContextOptimizer and ExperimentTracker, will further enhance the library’s capabilities, making it a comprehensive solution for context-aware LLM applications.
synapsense is designed to provide a structured and modular approach to managing context in applications that utilize Large Language Models. By offering tools to manage, build, optimize, and experiment with contextual examples, synapsense aims to make In-Context Learning more accessible and effective, allowing users to maximize the potential of LLMs in various use cases. The planned components, such as ContextOptimizer and ExperimentTracker, will further enhance the library’s capabilities, making it a comprehensive solution for context-aware LLM applications.
2 changes: 1 addition & 1 deletion example_openai_context_integration.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import os
import openai
from openai import OpenAI
from pyicl import ContextManager, PromptBuilder, ContextOptimizer
from synapsense import ContextManager, PromptBuilder, ContextOptimizer
import nltk
from nltk.tokenize import word_tokenize
from nltk.corpus import stopwords
Expand Down
2 changes: 1 addition & 1 deletion examples/example_openai_integration.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

client = OpenAI()
from openai import OpenAI
from pyicl import ContextManager, PromptBuilder
from synapsense import ContextManager, PromptBuilder

# Load API key from environment variable
api_key = os.environ.get("OPENAI_API_KEY")
Expand Down
6 changes: 3 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
from setuptools import setup, find_packages

setup(
name='pyicl',
name='synapsense',
version='1.0.0',
author='Richardson Lima',
author_email='[email protected]',
description='pyicl (Python In-Context Learning) is a Python library designed to facilitate the implementation of In-Context Learning (ICL) with Large Language Models (LLMs).',
description='synapsense (Python In-Context Learning) is a Python library designed to facilitate the implementation of In-Context Learning (ICL) with Large Language Models (LLMs).',
long_description=open('README.md').read(),
url='https://github.com/richardsonlima/pyicl.git',
url='https://github.com/richardsonlima/synapsense.git',
packages=find_packages(),
install_requires=['openai==1.46.0', 'nltk', 'stopwords'],
license='BSD License',
Expand Down
2 changes: 1 addition & 1 deletion src/__main__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import os
import openai
from pyicl import ContextManager, PromptBuilder, ContextOptimizer
from synapsense import ContextManager, PromptBuilder, ContextOptimizer
import nltk
nltk.download('stopwords')
from nltk.tokenize import word_tokenize
Expand Down

0 comments on commit e806397

Please sign in to comment.