modelmakerlibrary 0.1.0__tar.gz → 0.1.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (23) hide show
  1. {modelmakerlibrary-0.1.0/modelmakerlibrary.egg-info → modelmakerlibrary-0.1.1}/PKG-INFO +19 -17
  2. modelmakerlibrary-0.1.1/README.md +65 -0
  3. {modelmakerlibrary-0.1.0 → modelmakerlibrary-0.1.1/modelmakerlibrary.egg-info}/PKG-INFO +19 -17
  4. {modelmakerlibrary-0.1.0 → modelmakerlibrary-0.1.1}/pyproject.toml +2 -2
  5. modelmakerlibrary-0.1.0/README.md +0 -63
  6. {modelmakerlibrary-0.1.0 → modelmakerlibrary-0.1.1}/LICENSE +0 -0
  7. {modelmakerlibrary-0.1.0 → modelmakerlibrary-0.1.1}/accelerator/__init__.py +0 -0
  8. {modelmakerlibrary-0.1.0 → modelmakerlibrary-0.1.1}/accelerator/gpu.py +0 -0
  9. {modelmakerlibrary-0.1.0 → modelmakerlibrary-0.1.1}/accelerator/npu.py +0 -0
  10. {modelmakerlibrary-0.1.0 → modelmakerlibrary-0.1.1}/accelerator/tpu.py +0 -0
  11. {modelmakerlibrary-0.1.0 → modelmakerlibrary-0.1.1}/modelMakerLibrary.py +0 -0
  12. {modelmakerlibrary-0.1.0 → modelmakerlibrary-0.1.1}/modelmakerlibrary.egg-info/SOURCES.txt +0 -0
  13. {modelmakerlibrary-0.1.0 → modelmakerlibrary-0.1.1}/modelmakerlibrary.egg-info/dependency_links.txt +0 -0
  14. {modelmakerlibrary-0.1.0 → modelmakerlibrary-0.1.1}/modelmakerlibrary.egg-info/requires.txt +0 -0
  15. {modelmakerlibrary-0.1.0 → modelmakerlibrary-0.1.1}/modelmakerlibrary.egg-info/top_level.txt +0 -0
  16. {modelmakerlibrary-0.1.0 → modelmakerlibrary-0.1.1}/setup.cfg +0 -0
  17. {modelmakerlibrary-0.1.0 → modelmakerlibrary-0.1.1}/src/NeuralNetwork_create.py +0 -0
  18. {modelmakerlibrary-0.1.0 → modelmakerlibrary-0.1.1}/src/__init__.py +0 -0
  19. {modelmakerlibrary-0.1.0 → modelmakerlibrary-0.1.1}/src/dataset_function.py +0 -0
  20. {modelmakerlibrary-0.1.0 → modelmakerlibrary-0.1.1}/src/model.py +0 -0
  21. {modelmakerlibrary-0.1.0 → modelmakerlibrary-0.1.1}/src/packages.py +0 -0
  22. {modelmakerlibrary-0.1.0 → modelmakerlibrary-0.1.1}/src/tokenizers_function.py +0 -0
  23. {modelmakerlibrary-0.1.0 → modelmakerlibrary-0.1.1}/src/train.py +0 -0
@@ -1,12 +1,12 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: modelmakerlibrary
3
- Version: 0.1.0
3
+ Version: 0.1.1
4
4
  Summary: Python tools for dataset preparation and neural-network experiments
5
5
  License-Expression: Apache-2.0
6
6
  Project-URL: Homepage, https://github.com/IshaanShivalli/modelMakerLibrary
7
7
  Project-URL: Repository, https://github.com/IshaanShivalli/modelMakerLibrary
8
8
  Project-URL: Issues, https://github.com/IshaanShivalli/modelMakerLibrary/issues
9
- Project-URL: Documentation, https://github.com/IshaanShivalli/modelMakerLibrary/tree/main/docs
9
+ Project-URL: Documentation, https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/index.md
10
10
  Requires-Python: >=3.9
11
11
  Description-Content-Type: text/markdown
12
12
  License-File: LICENSE
@@ -60,27 +60,29 @@ print(mml.generate_text(model, "A short prompt", max_new_tokens=40))
60
60
 
61
61
  For text generation, the input path can contain UTF-8 `.txt`, `.json`, `.csv`,
62
62
  or `.tsv` files. JSON records use a `text` field; CSV and TSV files need a
63
- `text` column. See [Dataset guide](docs/datasets.md) for directory layouts and
64
- supported media types.
63
+ `text` column. See the [Dataset guide](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/datasets.md)
64
+ for directory layouts and supported media types.
65
65
 
66
66
  ## Documentation
67
67
 
68
- - [Documentation index](docs/index.md)
69
- - [Installation and compatibility](docs/installation.md)
70
- - [Quickstart and examples](docs/quickstart.md)
71
- - [Public API reference](docs/api.md)
72
- - [Dataset loading and conversion](docs/datasets.md)
73
- - [Models, training, and checkpoints](docs/models.md)
74
- - [Accelerator setup](docs/accelerators.md)
75
- - [Source module guide](docs/source-modules.md)
76
- - [Development and testing](docs/development.md)
77
- - [PyPI publishing and releases](docs/publishing.md)
68
+ - [Documentation index](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/index.md)
69
+ - [Installation and compatibility](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/installation.md)
70
+ - [Quickstart and examples](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/quickstart.md)
71
+ - [Public API reference](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/api.md)
72
+ - [Dataset loading and conversion](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/datasets.md)
73
+ - [Models, training, and checkpoints](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/models.md)
74
+ - [Accelerator setup](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/accelerators.md)
75
+ - [Source module guide](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/source-modules.md)
76
+ - [Development and testing](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/development.md)
77
+ - [PyPI publishing and releases](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/publishing.md)
78
78
 
79
- The self-contained [Python example](examples/api_quickstart.py) creates its
80
- own small dataset. The [Jupyter notebook](examples/modelmaker_quickstart.ipynb)
79
+ The self-contained [Python example](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/examples/api_quickstart.py)
80
+ creates its own small dataset. The
81
+ [Jupyter notebook](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/examples/modelmaker_quickstart.ipynb)
81
82
  also includes local Jupyter, Google Colab, and Kaggle setup instructions.
82
83
 
83
84
  ## License
84
85
 
85
- This project is licensed under the Apache License 2.0. See [LICENSE](LICENSE)
86
+ This project is licensed under the Apache License 2.0. See the
87
+ [LICENSE](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/LICENSE)
86
88
  for the full text.
@@ -0,0 +1,65 @@
1
+ # ModelMakerLibrary
2
+
3
+ ModelMakerLibrary is a Python library for dataset preparation, neural-network
4
+ construction, and small byte-level text-generation experiments built on
5
+ PyTorch.
6
+
7
+ ## Install
8
+
9
+ ```shell
10
+ python -m pip install modelmakerlibrary
11
+ ```
12
+
13
+ The package installs its required runtime dependencies, including PyTorch,
14
+ Torchvision, Transformers, pandas, and Matplotlib. The standard PyTorch wheels
15
+ are suitable for CPU use; consult the official PyTorch installation selector
16
+ for GPU-specific builds. TPU support is optional and requires a compatible
17
+ PyTorch/XLA installation in a supported environment.
18
+
19
+ ## Quick start
20
+
21
+ ```python
22
+ import modelMakerLibrary as mml
23
+
24
+ dataset = mml.load_dataset("data/text", model_type="text")
25
+ train_set, test_set = mml.split_dataset(dataset, train_ratio=80)
26
+ train_batches = mml.data_loader(train_set, batch_size=8, shuffle=True)
27
+
28
+ result = mml.train_text_generator(
29
+ dataset_path="data/text",
30
+ output_path="output/text_generator.pt",
31
+ epochs=2,
32
+ device="cpu",
33
+ )
34
+ model = mml.load_text_generator(result["checkpoint_path"])
35
+ print(mml.generate_text(model, "A short prompt", max_new_tokens=40))
36
+ ```
37
+
38
+ For text generation, the input path can contain UTF-8 `.txt`, `.json`, `.csv`,
39
+ or `.tsv` files. JSON records use a `text` field; CSV and TSV files need a
40
+ `text` column. See the [Dataset guide](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/datasets.md)
41
+ for directory layouts and supported media types.
42
+
43
+ ## Documentation
44
+
45
+ - [Documentation index](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/index.md)
46
+ - [Installation and compatibility](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/installation.md)
47
+ - [Quickstart and examples](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/quickstart.md)
48
+ - [Public API reference](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/api.md)
49
+ - [Dataset loading and conversion](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/datasets.md)
50
+ - [Models, training, and checkpoints](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/models.md)
51
+ - [Accelerator setup](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/accelerators.md)
52
+ - [Source module guide](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/source-modules.md)
53
+ - [Development and testing](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/development.md)
54
+ - [PyPI publishing and releases](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/publishing.md)
55
+
56
+ The self-contained [Python example](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/examples/api_quickstart.py)
57
+ creates its own small dataset. The
58
+ [Jupyter notebook](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/examples/modelmaker_quickstart.ipynb)
59
+ also includes local Jupyter, Google Colab, and Kaggle setup instructions.
60
+
61
+ ## License
62
+
63
+ This project is licensed under the Apache License 2.0. See the
64
+ [LICENSE](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/LICENSE)
65
+ for the full text.
@@ -1,12 +1,12 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: modelmakerlibrary
3
- Version: 0.1.0
3
+ Version: 0.1.1
4
4
  Summary: Python tools for dataset preparation and neural-network experiments
5
5
  License-Expression: Apache-2.0
6
6
  Project-URL: Homepage, https://github.com/IshaanShivalli/modelMakerLibrary
7
7
  Project-URL: Repository, https://github.com/IshaanShivalli/modelMakerLibrary
8
8
  Project-URL: Issues, https://github.com/IshaanShivalli/modelMakerLibrary/issues
9
- Project-URL: Documentation, https://github.com/IshaanShivalli/modelMakerLibrary/tree/main/docs
9
+ Project-URL: Documentation, https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/index.md
10
10
  Requires-Python: >=3.9
11
11
  Description-Content-Type: text/markdown
12
12
  License-File: LICENSE
@@ -60,27 +60,29 @@ print(mml.generate_text(model, "A short prompt", max_new_tokens=40))
60
60
 
61
61
  For text generation, the input path can contain UTF-8 `.txt`, `.json`, `.csv`,
62
62
  or `.tsv` files. JSON records use a `text` field; CSV and TSV files need a
63
- `text` column. See [Dataset guide](docs/datasets.md) for directory layouts and
64
- supported media types.
63
+ `text` column. See the [Dataset guide](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/datasets.md)
64
+ for directory layouts and supported media types.
65
65
 
66
66
  ## Documentation
67
67
 
68
- - [Documentation index](docs/index.md)
69
- - [Installation and compatibility](docs/installation.md)
70
- - [Quickstart and examples](docs/quickstart.md)
71
- - [Public API reference](docs/api.md)
72
- - [Dataset loading and conversion](docs/datasets.md)
73
- - [Models, training, and checkpoints](docs/models.md)
74
- - [Accelerator setup](docs/accelerators.md)
75
- - [Source module guide](docs/source-modules.md)
76
- - [Development and testing](docs/development.md)
77
- - [PyPI publishing and releases](docs/publishing.md)
68
+ - [Documentation index](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/index.md)
69
+ - [Installation and compatibility](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/installation.md)
70
+ - [Quickstart and examples](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/quickstart.md)
71
+ - [Public API reference](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/api.md)
72
+ - [Dataset loading and conversion](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/datasets.md)
73
+ - [Models, training, and checkpoints](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/models.md)
74
+ - [Accelerator setup](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/accelerators.md)
75
+ - [Source module guide](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/source-modules.md)
76
+ - [Development and testing](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/development.md)
77
+ - [PyPI publishing and releases](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/publishing.md)
78
78
 
79
- The self-contained [Python example](examples/api_quickstart.py) creates its
80
- own small dataset. The [Jupyter notebook](examples/modelmaker_quickstart.ipynb)
79
+ The self-contained [Python example](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/examples/api_quickstart.py)
80
+ creates its own small dataset. The
81
+ [Jupyter notebook](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/examples/modelmaker_quickstart.ipynb)
81
82
  also includes local Jupyter, Google Colab, and Kaggle setup instructions.
82
83
 
83
84
  ## License
84
85
 
85
- This project is licensed under the Apache License 2.0. See [LICENSE](LICENSE)
86
+ This project is licensed under the Apache License 2.0. See the
87
+ [LICENSE](https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/LICENSE)
86
88
  for the full text.
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "modelmakerlibrary"
7
- version = "0.1.0"
7
+ version = "0.1.1"
8
8
  description = "Python tools for dataset preparation and neural-network experiments"
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.9"
@@ -26,7 +26,7 @@ dependencies = [
26
26
  Homepage = "https://github.com/IshaanShivalli/modelMakerLibrary"
27
27
  Repository = "https://github.com/IshaanShivalli/modelMakerLibrary"
28
28
  Issues = "https://github.com/IshaanShivalli/modelMakerLibrary/issues"
29
- Documentation = "https://github.com/IshaanShivalli/modelMakerLibrary/tree/main/docs"
29
+ Documentation = "https://github.com/IshaanShivalli/modelMakerLibrary/blob/main/docs/index.md"
30
30
 
31
31
  [tool.setuptools]
32
32
  py-modules = ["modelMakerLibrary"]
@@ -1,63 +0,0 @@
1
- # ModelMakerLibrary
2
-
3
- ModelMakerLibrary is a Python library for dataset preparation, neural-network
4
- construction, and small byte-level text-generation experiments built on
5
- PyTorch.
6
-
7
- ## Install
8
-
9
- ```shell
10
- python -m pip install modelmakerlibrary
11
- ```
12
-
13
- The package installs its required runtime dependencies, including PyTorch,
14
- Torchvision, Transformers, pandas, and Matplotlib. The standard PyTorch wheels
15
- are suitable for CPU use; consult the official PyTorch installation selector
16
- for GPU-specific builds. TPU support is optional and requires a compatible
17
- PyTorch/XLA installation in a supported environment.
18
-
19
- ## Quick start
20
-
21
- ```python
22
- import modelMakerLibrary as mml
23
-
24
- dataset = mml.load_dataset("data/text", model_type="text")
25
- train_set, test_set = mml.split_dataset(dataset, train_ratio=80)
26
- train_batches = mml.data_loader(train_set, batch_size=8, shuffle=True)
27
-
28
- result = mml.train_text_generator(
29
- dataset_path="data/text",
30
- output_path="output/text_generator.pt",
31
- epochs=2,
32
- device="cpu",
33
- )
34
- model = mml.load_text_generator(result["checkpoint_path"])
35
- print(mml.generate_text(model, "A short prompt", max_new_tokens=40))
36
- ```
37
-
38
- For text generation, the input path can contain UTF-8 `.txt`, `.json`, `.csv`,
39
- or `.tsv` files. JSON records use a `text` field; CSV and TSV files need a
40
- `text` column. See [Dataset guide](docs/datasets.md) for directory layouts and
41
- supported media types.
42
-
43
- ## Documentation
44
-
45
- - [Documentation index](docs/index.md)
46
- - [Installation and compatibility](docs/installation.md)
47
- - [Quickstart and examples](docs/quickstart.md)
48
- - [Public API reference](docs/api.md)
49
- - [Dataset loading and conversion](docs/datasets.md)
50
- - [Models, training, and checkpoints](docs/models.md)
51
- - [Accelerator setup](docs/accelerators.md)
52
- - [Source module guide](docs/source-modules.md)
53
- - [Development and testing](docs/development.md)
54
- - [PyPI publishing and releases](docs/publishing.md)
55
-
56
- The self-contained [Python example](examples/api_quickstart.py) creates its
57
- own small dataset. The [Jupyter notebook](examples/modelmaker_quickstart.ipynb)
58
- also includes local Jupyter, Google Colab, and Kaggle setup instructions.
59
-
60
- ## License
61
-
62
- This project is licensed under the Apache License 2.0. See [LICENSE](LICENSE)
63
- for the full text.