Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
allnash committed Aug 13, 2024
1 parent 75feb07 commit 3dde667
Show file tree
Hide file tree
Showing 2 changed files with 110 additions and 11 deletions.
119 changes: 109 additions & 10 deletions docs/releases/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,22 +7,121 @@ Django Polly follows semantic versioning. This document outlines the changes in
.. toctree::
:maxdepth: 1

0.0.1
0.0.2
0.0.3
0.0.4
0.0.5
0.0.4
0.0.3
0.0.2
0.0.1

0.0.1
0.0.5
-----

*Date: August 12th, 2024*

* Adding images to the documentation
* Update README.rst
* Update version

0.0.4
-----

*Date: August 12th, 2024*

* Publishing workflow to PyPi
* Update topics in setup.py
* Update README.rst
* Update version

0.0.3
-----

Initial release of Django Polly.
*Date: August 12th, 2024*

* Basic LLM integration
* SmartConversations feature
* WebSocket support for real-time chat
* Admin interface for managing Parrots and SmartConversations
* Publishing workflow to PyPi
* Update topics in setup.py

0.0.2
-----

*Date: August 12th, 2024*

* Publishing workflow to PyPi

0.0.1
-----

*Date: August 12th, 2024*

We are excited to announce the initial release of Django Polly!

This version introduces the core functionality for integrating Language Learning Models (LLMs) into Django projects.

Features
^^^^^^^^

* LLM Integration:
* Support for creating and managing LLM instances (Parrots)
* Integration with various LLM backends
* Configurable AI model path
* SmartConversations:
* Framework for AI-powered conversations
* Support for both synchronous and asynchronous communication styles
* WebSocket Support:
* Real-time communication capabilities using Django Channels
* Custom consumers for handling WebSocket connections
* Admin Interface:
* Django admin integration for managing Parrots and SmartConversations
* Custom admin actions for LLM management
* Management Commands:
* `download_model` command for easy LLM model acquisition
* Extensibility:
* Flexible architecture allowing for custom LLM backends
* Easy integration with existing Django projects

Compatibility
^^^^^^^^^^^^^

* Python 3.8+
* Django 4.2 and 5.0
* Channels 3.0+

Installation
^^^^^^^^^^^^

You can install Django Polly 0.0.1 using pip:

.. code-block:: bash
pip install django-polly==0.0.1
Be sure to follow the :doc:`installation guide </installation>` for complete setup instructions.

Upgrade Instructions
^^^^^^^^^^^^^^^^^^^^

As this is the initial release, there are no upgrade instructions. For new installations, please refer to the :doc:`installation guide </installation>`.

Bug Fixes
^^^^^^^^^

As this is the initial release, there are no bug fixes to report.

Known Issues
^^^^^^^^^^^^

* Performance with very large LLM models may be suboptimal. We recommend using smaller, more efficient models for best results.
* WebSocket connections may require additional configuration in certain deployment environments.

Please report any issues you encounter on our `GitHub issue tracker <https://github.com/pollystack/django-polly/issues>`_.

What's Next
^^^^^^^^^^^

We are actively working on improving Django Polly. Future releases will focus on:

* Performance optimizations for LLM interactions
* Expanded LLM backend support
* Enhanced documentation and tutorials
* Improved error handling and debugging tools

Thank you for using Django Polly! We look forward to your feedback and contributions.
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

setup(
name='django-polly',
version='0.0.4',
version='0.0.5',
packages=find_packages(exclude=['tests*']),
package_data={
'django_polly': ['templates/**/*.html', 'static/**/*'],
Expand Down

0 comments on commit 3dde667

Please sign in to comment.