<p align="left">
<img width=15% src="https://dai.lids.mit.edu/wp-content/uploads/2018/06/Logo_DAI_highres.png" alt=“DAI-Lab” />
<i>An open source project from Data to AI Lab at MIT.</i>
</p>
<!-- Uncomment these lines after releasing the package to PyPI for version and downloads badges -->
<!--[](https://pypi.python.org/pypi/sigllm)-->
<!--[](https://pepy.tech/project/sigllm)-->
[](https://github.com/sintel-dev/sigllm/actions)
# sigllm
Signals plus LLMs
- Documentation: https://sintel-dev.github.io/sigllm
- Homepage: https://github.com/sintel-dev/sigllm
# Overview
TODO: Provide a short overview of the project here.
# Install
## Requirements
**sigllm** has been developed and tested on [Python 3.8, 3.9, 3.10 and 3.11](https://www.python.org/downloads/)
Also, although it is not strictly required, the usage of a [virtualenv](https://virtualenv.pypa.io/en/latest/)
is highly recommended in order to avoid interfering with other software installed in the system
in which **sigllm** is run.
These are the minimum commands needed to create a virtualenv using python3.8 for **sigllm**:
```bash
pip install virtualenv
virtualenv -p $(which python3.6) sigllm-venv
```
Afterwards, you have to execute this command to activate the virtualenv:
```bash
source sigllm-venv/bin/activate
```
Remember to execute it every time you start a new console to work on **sigllm**!
<!-- Uncomment this section after releasing the package to PyPI for installation instructions
## Install from PyPI
After creating the virtualenv and activating it, we recommend using
[pip](https://pip.pypa.io/en/stable/) in order to install **sigllm**:
```bash
pip install sigllm
```
This will pull and install the latest stable release from [PyPI](https://pypi.org/).
-->
## Install from source
With your virtualenv activated, you can clone the repository and install it from
source by running `make install` on the `stable` branch:
```bash
git clone git@github.com:sintel-dev/sigllm.git
cd sigllm
git checkout stable
make install
```
## Install for Development
If you want to contribute to the project, a few more steps are required to make the project ready
for development.
Please head to the [Contributing Guide](https://sintel-dev.github.io/sigllm/contributing.html#get-started)
for more details about this process.
# Quickstart
In this short tutorial we will guide you through a series of steps that will help you
getting started with **sigllm**.
TODO: Create a step by step guide here.
# What's next?
For more details about **sigllm** and all its possibilities
and features, please check the [documentation site](
https://sintel-dev.github.io/sigllm/).
# History
Raw data
{
"_id": null,
"home_page": "https://github.com/sintel-dev/sigllm",
"name": "sigllm",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "sigllm sigllm sigllm",
"author": "MIT Data To AI Lab",
"author_email": "dailabmit@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/91/47/61c47d2e086b599d1a3e5f6b3eebfda980521d715166f977780aa85571b3/sigllm-0.0.1.dev0.tar.gz",
"platform": null,
"description": "<p align=\"left\">\n<img width=15% src=\"https://dai.lids.mit.edu/wp-content/uploads/2018/06/Logo_DAI_highres.png\" alt=\u201cDAI-Lab\u201d />\n<i>An open source project from Data to AI Lab at MIT.</i>\n</p>\n\n<!-- Uncomment these lines after releasing the package to PyPI for version and downloads badges -->\n<!--[](https://pypi.python.org/pypi/sigllm)-->\n<!--[](https://pepy.tech/project/sigllm)-->\n[](https://github.com/sintel-dev/sigllm/actions)\n\n\n\n# sigllm\n\nSignals plus LLMs\n\n- Documentation: https://sintel-dev.github.io/sigllm\n- Homepage: https://github.com/sintel-dev/sigllm\n\n# Overview\n\nTODO: Provide a short overview of the project here.\n\n# Install\n\n## Requirements\n\n**sigllm** has been developed and tested on [Python 3.8, 3.9, 3.10 and 3.11](https://www.python.org/downloads/)\n\nAlso, although it is not strictly required, the usage of a [virtualenv](https://virtualenv.pypa.io/en/latest/)\nis highly recommended in order to avoid interfering with other software installed in the system\nin which **sigllm** is run.\n\nThese are the minimum commands needed to create a virtualenv using python3.8 for **sigllm**:\n\n```bash\npip install virtualenv\nvirtualenv -p $(which python3.6) sigllm-venv\n```\n\nAfterwards, you have to execute this command to activate the virtualenv:\n\n```bash\nsource sigllm-venv/bin/activate\n```\n\nRemember to execute it every time you start a new console to work on **sigllm**!\n\n<!-- Uncomment this section after releasing the package to PyPI for installation instructions\n## Install from PyPI\n\nAfter creating the virtualenv and activating it, we recommend using\n[pip](https://pip.pypa.io/en/stable/) in order to install **sigllm**:\n\n```bash\npip install sigllm\n```\n\nThis will pull and install the latest stable release from [PyPI](https://pypi.org/).\n-->\n\n## Install from source\n\nWith your virtualenv activated, you can clone the repository and install it from\nsource by running `make install` on the `stable` branch:\n\n```bash\ngit clone git@github.com:sintel-dev/sigllm.git\ncd sigllm\ngit checkout stable\nmake install\n```\n\n## Install for Development\n\nIf you want to contribute to the project, a few more steps are required to make the project ready\nfor development.\n\nPlease head to the [Contributing Guide](https://sintel-dev.github.io/sigllm/contributing.html#get-started)\nfor more details about this process.\n\n# Quickstart\n\nIn this short tutorial we will guide you through a series of steps that will help you\ngetting started with **sigllm**.\n\nTODO: Create a step by step guide here.\n\n# What's next?\n\nFor more details about **sigllm** and all its possibilities\nand features, please check the [documentation site](\nhttps://sintel-dev.github.io/sigllm/).\n\n\n# History\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "Signals plus LLMs",
"version": "0.0.1.dev0",
"project_urls": {
"Homepage": "https://github.com/sintel-dev/sigllm"
},
"split_keywords": [
"sigllm",
"sigllm",
"sigllm"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "811fa66c893da93c3cebeab5c20fade235c65e8602f524c80b4f0680822406dd",
"md5": "9b7433d9e8df82e66d06c238d1941f4e",
"sha256": "a8f04ad7540573fcc330804a36aba55ffaf32af6cc4befe9f704a406106c030e"
},
"downloads": -1,
"filename": "sigllm-0.0.1.dev0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "9b7433d9e8df82e66d06c238d1941f4e",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 4438,
"upload_time": "2023-12-06T02:40:48",
"upload_time_iso_8601": "2023-12-06T02:40:48.493411Z",
"url": "https://files.pythonhosted.org/packages/81/1f/a66c893da93c3cebeab5c20fade235c65e8602f524c80b4f0680822406dd/sigllm-0.0.1.dev0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "914761c47d2e086b599d1a3e5f6b3eebfda980521d715166f977780aa85571b3",
"md5": "541a1ec9889c131507c34f851bd93a68",
"sha256": "0b94f76606604087aeb48114fcd3222d1d05f52dfa328bfcb91c09266e57ac30"
},
"downloads": -1,
"filename": "sigllm-0.0.1.dev0.tar.gz",
"has_sig": false,
"md5_digest": "541a1ec9889c131507c34f851bd93a68",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 47352,
"upload_time": "2023-12-06T02:40:52",
"upload_time_iso_8601": "2023-12-06T02:40:52.181467Z",
"url": "https://files.pythonhosted.org/packages/91/47/61c47d2e086b599d1a3e5f6b3eebfda980521d715166f977780aa85571b3/sigllm-0.0.1.dev0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-06 02:40:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sintel-dev",
"github_project": "sigllm",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "sigllm"
}
JSON
