Skip to content

Commit

Permalink
[FIRST]
Browse files Browse the repository at this point in the history
  • Loading branch information
Your Name committed Sep 10, 2024
1 parent 19fa555 commit 57d08f6
Show file tree
Hide file tree
Showing 69 changed files with 3 additions and 5,580 deletions.
13 changes: 0 additions & 13 deletions .readthedocs.yml

This file was deleted.

22 changes: 0 additions & 22 deletions Makefile

This file was deleted.

61 changes: 3 additions & 58 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,67 +1,12 @@
[![Multi-Modality](agorabanner.png)](https://discord.com/servers/agora-999382051935506503)

# Python Package Template
# Chai-1

[![Join our Discord](https://img.shields.io/badge/Discord-Join%20our%20server-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/agora-999382051935506503) [![Subscribe on YouTube](https://img.shields.io/badge/YouTube-Subscribe-red?style=for-the-badge&logo=youtube&logoColor=white)](https://www.youtube.com/@kyegomez3242) [![Connect on LinkedIn](https://img.shields.io/badge/LinkedIn-Connect-blue?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/kye-g-38759a207/) [![Follow on X.com](https://img.shields.io/badge/X.com-Follow-1DA1F2?style=for-the-badge&logo=x&logoColor=white)](https://x.com/kyegomezb)

A easy, reliable, fluid template for python packages complete with docs, testing suites, readme's, github workflows, linting and much much more


## Installation

You can install the package using pip

```bash
pip install -e .
```

# Usage
```python
print("hello world")

```



### Code Quality 🧹

- `make style` to format the code
- `make check_code_quality` to check code quality (PEP8 basically)
- `black .`
- `ruff . --fix`

### Tests 🧪

[`pytests`](https://docs.pytest.org/en/7.1.x/) is used to run our tests.

### Publish on PyPi 🚀

**Important**: Before publishing, edit `__version__` in [src/__init__](/src/__init__.py) to match the wanted new version.

```
poetry build
poetry publish
```

### CI/CD 🤖

We use [GitHub actions](https://github.com/features/actions) to automatically run tests and check code quality when a new PR is done on `main`.

On any pull request, we will check the code quality and tests.

When a new release is created, we will try to push the new code to PyPi. We use [`twine`](https://twine.readthedocs.io/en/stable/) to make our life easier.

The **correct steps** to create a new realease are the following:
- edit `__version__` in [src/__init__](/src/__init__.py) to match the wanted new version.
- create a new [`tag`](https://git-scm.com/docs/git-tag) with the release name, e.g. `git tag v0.0.1 && git push origin v0.0.1` or from the GitHub UI.
- create a new release from GitHub UI

The CI will run when you create the new release.

# Docs
We use MK docs. This repo comes with the zeta docs. All the docs configurations are already here along with the readthedocs configs.

An free and open source community implementation of Chai-1 in PyTorch. [Paper is here](https://chaiassets.com/chai-1/paper/technical_report_v1.pdf)

Join our discord to help us implement this paper!

# License
MIT
Binary file removed docs/.DS_Store
Binary file not shown.
42 changes: 0 additions & 42 deletions docs/applications/customer_support.md

This file was deleted.

Empty file removed docs/applications/enterprise.md
Empty file.
64 changes: 0 additions & 64 deletions docs/applications/marketing_agencies.md

This file was deleted.

6 changes: 0 additions & 6 deletions docs/architecture.md

This file was deleted.

7 changes: 0 additions & 7 deletions docs/assets/css/extra.css

This file was deleted.

Binary file removed docs/assets/img/SwarmsLogoIcon.png
Binary file not shown.
Binary file removed docs/assets/img/swarmsbanner.png
Binary file not shown.
Binary file removed docs/assets/img/tools/output.png
Binary file not shown.
Binary file removed docs/assets/img/tools/poetry_setup.png
Binary file not shown.
Binary file removed docs/assets/img/tools/toml.png
Binary file not shown.
Binary file removed docs/assets/img/zetascale.png
Binary file not shown.
86 changes: 0 additions & 86 deletions docs/bounties.md

This file was deleted.

Loading

0 comments on commit 57d08f6

Please sign in to comment.