kiwi-booster 0.2.1

Python utility functions and classes for KiwiBot AI&Robotics team

Kiwi Booster

Python utils and classes for KiwiBot AI&Robotics team
Make a Pull Request · Report Bug · Request Feature

---

Table of contents

• About The Project
• Getting started
  • Installation
  • Usage
• Contributing
  • License
  • Contact

---

About The Project

This library contains utility functions and classes from Python that are commonly used in the AI&Robotics team. It is divided into 5 main sections:

• common_utils: Some common utils that are normally used in most of the projects.

  • kiwi_booster.loggers This module contains GCP and local loggers with a predefined format.

  • kiwi_booster.mixed This module contains miscellaneous utils from multiple objectives.

  • kiwi_booster.requests This module contains utils for working with HTTP requests.

• gcp_utils: Utils that are related to the Google Cloud Platform.

  • kiwi_booster.gcp_utils.bigquery This module contains utils for working with BigQuery.

  • kiwi_booster.gcp_utils.kfp This module contains utils for working with Vertex (Kubeflow) Pipelines.

  • kiwi_booster.gcp_utils.secrets This module contains utils for working with Google Cloud Secrets Manager.

  • kiwi_booster.gcp_utils.storage This module contains utils for working with Google Cloud Storage.

• ml_utils: Utils that are related to Machine Learning.

  • kiwi_booster.ml_utils.benchmarks This module contains utils for benchmarking machine learning models.

  • kiwi_booster.ml_utils.prediction This module contains utils to handle the prediction of the semantic segmentation model.

• decorators: Decorators that are used to improve the codebase.

• slack_utils: Utils that are related to Slack.

(back to top)

---

Getting started

Installation

To install the package, simply run the following command:

pip install kiwi-booster

Usage

To use the package, we recommend using relative imports for each function or class you want to import to improve readability. For example, if you want to use the SlackBot class, you can import it as follows:

from kiwi_booster.slack_utils import SlackBot

slack_bot = SlackBot(
        SLACK_TOKEN,
        SLACK_CHANNEL_ID,
        SLACK_BOT_IMAGE_URL,
        image_alt_text="Bot description",
)

Or any decorator as follows:

from kiwi_booster.decorators import try_catch_log

@try_catch_log
def my_function():
    # Do something

As well, we recommend importing them in a separate section from the rest of the imports.

(back to top)

---

Contributing

If you'd like to contribute to Kiwi Booster, please feel free to submit a pull request! We're always looking for ways to improve our codebase and make it more useful to a wider range of use cases. You can also request a new feature by submitting an issue.

License

Kiwi Booster is licensed under the GNU license. See the LICENSE file for more information.

Contact

Sebastian Hernández Reyes - Machine Learning Engineer - Mail contact

Carlos Alvarez - Machine Learning Engineer Lead - Mail contact

(back to top)