Skip to content

Commit

Permalink
re-structured package
Browse files Browse the repository at this point in the history
  • Loading branch information
mehfuzh committed Aug 9, 2024
1 parent 9a8598c commit c9b6687
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 15 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Use the CLI to upload, manage, and query documents based on fine-tuned LLM models. It uses the smartloop API to manage projects and documents and gives you an easy way to quickly process contents and reason based on it.


![PyPI - Version](https://img.shields.io/pypi/v/smartloop-cli)
![PyPI - Version](https://img.shields.io/pypi/v/smartloop)

## Requirements

Expand All @@ -17,7 +17,7 @@ Use the CLI to upload, manage, and query documents based on fine-tuned LLM model
Install the CLI with the following command:

```
pip install -U smartloop-cli
pip install -U smartloop
```
Once installed, check that everything is setup correclty:
Expand Down Expand Up @@ -48,30 +48,30 @@ You will receive an email with the `token` that is needed to login into the CLI.

Login to the CLI in the follwoing way using the token recevied in email:

```
smartloop-cli login
```bash
smartloop login
```

This command will prompt you for your token, copy and pase the token that you have recevied in your email. Next step it to create a project, you can do so with the following command:

```bash
smartloop-cli project create --name Lexic
smartloop project create --name Lexic
```

## Upload Document

Once the project is created , upload documents from your folder or a specific file, in this case I am uploading the a document describing Microsoft online services form my local machine

```bash
smartloop-cli upload --path=~/document1.pdf
smartloop upload --path=~/document1.pdf
```

## Run It

Finally, once the document is uploaded and processed, run the CLI to query:

```bash
smartloop-cli run
smartloop run
```

This will bring up the prompt to query your information from your uploaded document
Expand Down Expand Up @@ -105,7 +105,7 @@ smartloop-cli project select
In order to set `temparature` of your conversation, which ranges from 0.0 to 1.0, use the following command:

```bash
smartloop-cli project set --id=project_id --temp=0.3
smartloop project set --id=project_id --temp=0.3

```

Expand All @@ -116,13 +116,13 @@ The higher value tends towards more creative answer
To get the project Id , use the following, the will also show you the currently selected project:

```bash
smartloop-cli project list
smartloop project list
```

To delete a project, use:

```bash
smartloop-cli project delete --id=project_id
smartloop project delete --id=project_id
```

## Supported Documents types
Expand Down
8 changes: 4 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@
]

setup(
name='smartloop-cli',
name='smartloop',
description='Smartloop Command Line interface to process documents using LLM',
version=__version__,
author_email='mehfuz@smartloop.ai',
author='Smartloop Inc.',
url='https://github.com/SmartloopHQ/smartloop-cli',
keywords=['LLM', 'framework', 'llama3', 'phi3', 'platform'],
url='https://github.com/LexicHQ/smartloop',
keywords=['LLM', 'framework', 'llama3', 'phi3', 'platform', 'document'],
packages=find_packages(exclude=['tests*']),
py_modules=['main', 'constants'],
license='LICENSE.txt',
Expand All @@ -40,6 +40,6 @@
],
entry_points='''
[console_scripts]
smartloop-cli=main:bootstrap
smartloop=main:bootstrap
'''
)
2 changes: 1 addition & 1 deletion smartloop/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

__version__="1.0.2"
__version__="1.1.2"

0 comments on commit c9b6687

Please sign in to comment.