Skip to content

Latest commit

 

History

History
77 lines (43 loc) · 1.43 KB

README.md

File metadata and controls

77 lines (43 loc) · 1.43 KB

How to create a custom tf-al package?

  1. Clone this directory with
git clone https://github.com/ExLeonem/tf-al-ext
  1. Replace the ext in the folder names as well as in the pyproject.toml with a personal extension.
  2. Setup poetry and install dependencies
  3. Start developing and extending the package
  4. Share via github/pypi

Directory structure

To keep an easy and generic API across different extension, please keep following structure.

Directory name Description
\wrapper Custom model wrappers.
\score Custom scores to evaluate active learning experiments
\utils For utility functions

No fitting folder? Just create a custom one.

Versioning

Follow the semantic versioning rule set. (v. Major.Minor.Patch)

Scripts

Unittests

To execute unit tests, type in following command:

poetry run pytest

Depenency managament

To add another package dependency, execute following command

poetry add <package-name>

Likewise if you want to delete a dependency:

poetry remove <package-name>

Publish to pypi

Run following commands one after another.

poetry build
poetry publish

For other commands that are executeable check the documentation of poetry.