Skip to content

Commit 0e28d1f

Browse files
author
Kye
committed
[README]
1 parent 39aacd0 commit 0e28d1f

File tree

3 files changed

+10
-64
lines changed

3 files changed

+10
-64
lines changed

README.md

+2-57
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,7 @@
11
[![Multi-Modality](agorabanner.png)](https://discord.gg/qUtxnK2NMf)
22

3-
# Python Package Template
4-
A easy, reliable, fluid template for python packages complete with docs, testing suites, readme's, github workflows, linting and much much more
5-
6-
7-
## Installation
8-
9-
You can install the package using pip
10-
11-
```bash
12-
pip install -e .
13-
```
14-
15-
# Usage
16-
```python
17-
print("hello world")
18-
19-
```
20-
21-
22-
23-
### Code Quality 🧹
24-
25-
- `make style` to format the code
26-
- `make check_code_quality` to check code quality (PEP8 basically)
27-
- `black .`
28-
- `ruff . --fix`
29-
30-
### Tests 🧪
31-
32-
[`pytests`](https://docs.pytest.org/en/7.1.x/) is used to run our tests.
33-
34-
### Publish on PyPi 🚀
35-
36-
**Important**: Before publishing, edit `__version__` in [src/__init__](/src/__init__.py) to match the wanted new version.
37-
38-
```
39-
poetry build
40-
poetry publish
41-
```
42-
43-
### CI/CD 🤖
44-
45-
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`.
46-
47-
On any pull request, we will check the code quality and tests.
48-
49-
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.
50-
51-
The **correct steps** to create a new realease are the following:
52-
- edit `__version__` in [src/__init__](/src/__init__.py) to match the wanted new version.
53-
- 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.
54-
- create a new release from GitHub UI
55-
56-
The CI will run when you create the new release.
57-
58-
# Docs
59-
We use MK docs. This repo comes with the zeta docs. All the docs configurations are already here along with the readthedocs configs.
3+
# Screen AI
4+
Implementation of the ScreenAI model from the paper: "A Vision-Language Model for UI and Infographics Understanding"
605

616

627

pyproject.toml

+6-6
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ version = "0.0.1"
88
description = "Paper - Pytorch"
99
license = "MIT"
1010
authors = ["Kye Gomez <[email protected]>"]
11-
homepage = "https://github.com/kyegomez/paper"
12-
documentation = "https://github.com/kyegomez/paper" # Add this if you have documentation.
11+
homepage = "https://github.com/kyegomez/ScreenAI"
12+
documentation = "https://github.com/kyegomez/ScreenAI" # Add this if you have documentation.
1313
readme = "README.md" # Assuming you have a README.md
14-
repository = "https://github.com/kyegomez/paper"
14+
repository = "https://github.com/kyegomez/ScreenAI"
1515
keywords = ["artificial intelligence", "deep learning", "optimizers", "Prompt Engineering"]
1616
classifiers = [
1717
"Development Status :: 4 - Beta",
@@ -25,9 +25,9 @@ classifiers = [
2525
python = "^3.6"
2626
swarms = "*"
2727
zetascale = "*"
28-
29-
[tool.poetry.dev-dependencies]
30-
# Add development dependencies here
28+
einops = "*"
29+
torch = "*"
30+
torchvision = "*"
3131

3232

3333
[tool.poetry.group.lint.dependencies]

requirements.txt

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
torch
22
zetascale
3-
swarms
3+
einops
4+
torch

0 commit comments

Comments
 (0)