Add GA for the SparseML (#1487)

* Add google analytics logging for SparseML. Testing -- QA will handle to ensure GA events are being populated

* rename analytics packages to private for init files

---------

Co-authored-by: Benjamin Fineran <bfineran@users.noreply.github.com>

src/sparseml/__init__.py

@@ -43,6 +43,10 @@
     save_sparsification_info,
     load_sparsification_info,
 )
+from .analytics import sparseml_analytics as _analytics
+
+
+_analytics.send_event("python.import")
 
 try:
     from sparsezoo.package import check_package_version as _check_package_version

src/sparseml/analytics.py

@@ -0,0 +1,23 @@
+# Copyright (c) 2021 - present / Neuralmagic, Inc. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from sparseml.version import version as sparseml_version
+from sparsezoo.analytics import GoogleAnalytics
+
+
+__all__ = ["sparseml_analytics"]
+
+
+# analytics client for sparseml, to disable set NM_DISABLE_ANALYTICS=1
+sparseml_analytics = GoogleAnalytics("sparseml", sparseml_version)

src/sparseml/keras/__init__.py

@@ -18,6 +18,11 @@
 
 # flake8: noqa
 
+from sparseml.analytics import sparseml_analytics as _analytics
+
 from .base import *
 from .framework import detect_framework, framework_info, is_supported
 from .sparsification import sparsification_info
+
+
+_analytics.send_event("keras.init")

src/sparseml/onnx/__init__.py

@@ -18,7 +18,12 @@
 
 # flake8: noqa
 
+from sparseml.analytics import sparseml_analytics as _analytics
+
 from .base import *
 from .benchmark import *
 from .framework import detect_framework, framework_info, is_supported
 from .sparsification import ModelInfo, get_analyzer_impls, sparsification_info
+
+
+_analytics.send_event("onnx.init")

src/sparseml/openpifpaf/__init__.py

@@ -11,3 +11,8 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+
+from sparseml.analytics import sparseml_analytics as _analytics
+
+
+_analytics.send_event("openpifpaf.init")

src/sparseml/pytorch/image_classification/__init__.py

@@ -11,3 +11,8 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+
+from sparseml.analytics import sparseml_analytics as _analytics
+
+
+_analytics.send_event("python.pytorch.image_classification.init")

src/sparseml/pytorch/optim/manager.py

@@ -27,6 +27,7 @@
 from torch.nn import Module
 from torch.optim.optimizer import Optimizer
 
+from sparseml.analytics import sparseml_analytics
 from sparseml.optim import (
     BaseManager,
     add_framework_metadata,
@@ -303,6 +304,7 @@ def __init__(
         modifiers: List[ScheduledModifier],
         metadata: Optional[Dict[str, Any]] = None,
     ):
+        sparseml_analytics.send_event("python.pytorch.manager")
         super().__init__(modifiers=modifiers, metadata=metadata)
         self._initialize_epoch = 0
 

src/sparseml/pytorch/torchvision/__init__.py

@@ -11,3 +11,8 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+
+from sparseml.analytics import sparseml_analytics as _analytics
+
+
+_analytics.send_event("python.pytorch.torchvision.init")

src/sparseml/tensorflow_v1/__init__.py

@@ -18,6 +18,11 @@
 
 # flake8: noqa
 
+from sparseml.analytics import sparseml_analytics as _analytics
+
 from .base import *
 from .framework import detect_framework, framework_info, is_supported
 from .sparsification import sparsification_info
+
+
+_analytics.send_event("python.tensorflow_v1.init")

src/sparseml/transformers/__init__.py

@@ -21,8 +21,11 @@
 import logging as _logging
 
 import pkg_resources
+from sparseml.analytics import sparseml_analytics as _analytics
 
 
+_analytics.send_event("python.transformers.init")
+
 _EXPECTED_VERSION = "4.23.1"
 
 

src/sparseml/yolact/__init__.py

@@ -20,6 +20,10 @@
 import logging as _logging
 from collections import namedtuple
 
+from sparseml.analytics import sparseml_analytics as _analytics
+
+
+_analytics.send_event("python.yolact.init")
 
 _LOGGER = _logging.getLogger(__name__)
 _NM_YOLACT_LINK_TEMPLATE = (

src/sparseml/yolov5/__init__.py

@@ -19,9 +19,13 @@
 
 import logging as _logging
 
+from sparseml.analytics import sparseml_analytics as _analytics
+
 from .helpers import *
 
 
+_analytics.send_event("python.yolov5.init")
+
 try:
     import yolov5 as _yolov5
 

src/sparseml/yolov8/__init__.py

@@ -13,8 +13,11 @@
 # limitations under the License.
 
 import ultralytics
+from sparseml.analytics import sparseml_analytics as _analytics
 
 
+_analytics.send_event("python.yolov8.init")
+
 if "8.0.30" not in ultralytics.__version__:
     raise ValueError(
         f"ultralytics==8.0.30 is required, found {ultralytics.__version__}. "