Skip to content

Commit b527734

Browse files
committed
[chore] add more to documentation
1 parent 5c958a0 commit b527734

File tree

2 files changed

+13
-3
lines changed

2 files changed

+13
-3
lines changed

docs/changelog.rst

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
1-
tuneapi Changelog
2-
=================
1+
Changelog
2+
=========
3+
4+
This package is already used in production at Tune AI, please do not wait for release ``1.x.x`` for stability, or expect
5+
to reach ``1.0.0``. We do not follow the general rules of semantic versioning, and there can be breaking changes between
6+
minor versions.
7+
8+
All relevant steps to be taken will be mentioned here.
39

410
0.4.12
511
------

docs/index.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@
66
tuneapi documentation
77
=====================
88

9-
TuneAPI
9+
Welcome to the documentation for ``tuneapi`` package. This combines the most commonly used python utilities across Tune AI
10+
into a single MIT-licensed package. It contains 3 major submodules:
11+
- ``tuneapi.apis``: Contains all the APIs that are used to interact with the Tune AI services and LLM providers
12+
- ``tuneapi.types``: Contains all the types that are used generally
13+
- ``tuneapi.utils``: Contains all the utility functions that are used across the Tune AI codebase. This is pretty interesting
1014

1115
.. toctree::
1216
:maxdepth: 2

0 commit comments

Comments
 (0)