Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove TFLM from Arduino library download cache #1748

Merged
merged 1 commit into from
Aug 31, 2022

Conversation

wrighkv1
Copy link
Contributor

@wrighkv1 wrighkv1 commented Aug 24, 2022

Removed 'https://github.com/bcmi-labs/tensorflow_lite_mirror' from the list
Removing TFLM from Arduino library download cache.

@github-actions github-actions bot added the topic: removal Remove library from the list label Aug 24, 2022
@github-actions
Copy link
Contributor

Hi @wrighkv1.
Your pull request has been detected as something other than a Library Manager submission.
A maintainer will need to review it before it can be merged.

If you intended to submit a library, please check the instructions and update your pull request if necessary:
https://github.com/arduino/library-registry/blob/main/README.md#instructions

@github-actions github-actions bot requested a review from per1234 August 24, 2022 20:25
@per1234
Copy link
Contributor

per1234 commented Aug 24, 2022

Hi @wrighkv1. Although everyone is welcome to submit any library, changes to existing registry entries may only be done with the authorization of a maintainer of the library. Unfortunately, I was unable to verify that this request was authorized.

Please provide proof that this request is authorized. Thanks!

@per1234 per1234 self-assigned this Aug 24, 2022
@per1234 per1234 added the status: waiting for information More information must be provided before work can proceed label Aug 24, 2022
@wrighkv1 wrighkv1 changed the title Update repositories.txt Remove TFLM from Arduino library download cache Aug 24, 2022
@wrighkv1
Copy link
Contributor Author

Hi per1234,

Thanks for the quick response. I am a member of the TensorFlow Lite Micro team. We would like to remove this TFLM library from the Arduino library download cache.

@advaitjain
Copy link

Hi @wrighkv1. Although everyone is welcome to submit any library, changes to existing registry entries may only be done with the authorization of a maintainer of the library. Unfortunately, I was unable to verify that this request was authorized.

Please provide proof that this request is authorized. Thanks!

@per1234, how do we go about finding who the maintainer of the library is? The git history / blame for repositories.txt isn't letting me get to that information and the registry entry that we want to remove (https://github.com/bcmi-labs/tensorflow_lite_mirror) is not a valid repository.

The TensorFlow Lite Micro team (of which both me and @wrighkv1 are members) is maintaining the library at https://github.com/tensorflow/tflite-micro-arduino-examples.

In the current situation, the version of TfLite Micro that is available from the Library Manager is unclear to us.

@per1234
Copy link
Contributor

per1234 commented Aug 24, 2022

how do we go about finding who the maintainer of the library is?

Arduino maintains this library (not the source code itself, but the packaging of TensorFlow Lite into a valid Arduino library). "bcmi-labs" is one of the GitHub organizations owned by Arduino.

the registry entry that we want to remove (https://github.com/bcmi-labs/tensorflow_lite_mirror) is not a valid repository.

It is a valid repository. It is only that it is a private repository. The only reason for it being private is to avoid wasting the time of contributors who might submit issues or pull requests for changes to the mirrored code, not understanding that those contributions must be made to the upstream repository.

The contents of the repository are of course no secret, as they are publicly available from the Arduino Library Manager. But the Git data is removed from all the library packages in Library Manager for efficiency, so we do miss being able to take a look at the revision control history.

the version of TfLite Micro that is available from the Library Manager is unclear to us.

I apologize for any confusion. I will discuss this with the relevant people at Arduino.

@per1234 per1234 removed the status: waiting for information More information must be provided before work can proceed label Aug 26, 2022
@per1234
Copy link
Contributor

per1234 commented Aug 29, 2022

Hi @wrighkv1 and @advaitjain. Before proceeding with the requested removal, I would like to make sure you are fully aware of the implications:

Loss of Library Manager installation option

The library will be removed completely from the Arduino Library Manager index, which will break any tutorials, etc. which rely on this standard installation method. For example:

Loss of availability of Arduino's releases

It might be challenging for those interested in using an existing project which pinned one of the releases of the library formerly distributed by Arduino to source that same version elsewhere, since tensorflow/tflite-micro-arduino-examples does not have any tags and it seems not so simple for the average user to derive the library directly from the source in the tensorflow/tflite-micro repository.

The alternative will be for them to use a version of the library the project was not validated for.

Arduino provides precompiled releases of the library

Arduino's packaging infrastructure for the library produces precompiled releases which dramatically reduce what would otherwise be a lengthy compilation time for the user's sketches that use the library.

@ladyada
Copy link
Contributor

ladyada commented Aug 29, 2022

for many adafruit libraries we had some questions, so this is good timing - you can make github repos that are public but do not have Issues or forks enabled (without forking you wont get PRs submitted), great for keeping things quiet :)

image

@per1234
Copy link
Contributor

per1234 commented Aug 29, 2022

Thanks @ladyada! That "Allow forking" setting is very interesting to me for use in a couple other public mirror repositories:

Unfortunately, I looked into their settings and didn't see this "Allow forking" setting:

image

I do see it in a private repository though. Was the screenshot you shared from a private repo?

GitHub's docs seem to indicate the feature is for private repos:

https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository

For preventing PRs, we are currently using the "Interaction Limits" setting. The only problem with this approach is it has a maximum period of 6 months, so we must remember to periodically cycle the setting to avoid it expiring.

@advaitjain
Copy link

Thanks a lot for the detailed replies!

After giving it some more thought we came to the conclusion that we would still like to continue with removing the library manager installation for Tensorflow Lite Micro.

@per1234
Copy link
Contributor

per1234 commented Aug 30, 2022

@wrighkv1 @advaitjain I am confirming your request.

Unlike submissions, this type of request is still handled manually. The Library Manager index maintainer occasionally comes through to clear all the outstanding requests. They will merge this pull request when it is done. You will get a notification from GitHub at that time.

@per1234 per1234 added the status: pending backend Depends on backend maintenance operations label Aug 30, 2022
@per1234 per1234 removed their assignment Aug 30, 2022
@umbynos umbynos self-assigned this Aug 31, 2022
Copy link
Contributor

@umbynos umbynos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done:

2022/08/31 16:21:41 Loaded 5121 libraries from DB
Removing Arduino_TensorFlowLite
warning: Library Git clone folder /home/ubuntu/workspace/gitclones/github.com/bcmi-labs/tensorflow_lite_mirror not present
Success!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
conclusion: resolved Issue was resolved topic: removal Remove library from the list
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants