[Trainer] Support show paddlenlp commit id (#7047)

* support install with git commit
* support trainer for paddlenlp commit id.

paddlenlp/__init__.py

@@ -48,6 +48,7 @@ from . import (
     trainer,
     transformers,
     utils,
+    version,
 )
 from .server import SimpleServer
 from .taskflow import Taskflow

paddlenlp/trainer/trainer.py

@@ -2646,9 +2646,11 @@ class Trainer:
         if args is None:
             args = self.args
             key = "Training"
+        import paddlenlp
 
         logger.info("{:^40}".format("{} Configuration Arguments".format(key)))
         logger.info("{:30}: {}".format("paddle commit id", paddle.version.commit))
+        logger.info("{:30}: {}".format("paddlenlp commit id", paddlenlp.version.commit))
 
         for a in dir(args):
             if a[:2] != "__":  # don't print double underscore methods

paddlenlp/trainer/training_args.py

@@ -1372,8 +1372,11 @@ class TrainingArguments:
             args = self
             key = "Training"
 
+        import paddlenlp
+
         logger.info("{:^40}".format("{} Configuration Arguments".format(key)))
         logger.info("{:30}: {}".format("paddle commit id", paddle.version.commit))
+        logger.info("{:30}: {}".format("paddlenlp commit id", paddlenlp.version.commit))
 
         for a in dir(args):
             if a[:2] != "__":  # don't print double underscore methods

paddlenlp/version/__init__.py

@@ -0,0 +1,51 @@
+# Copyright (c) 2023 PaddlePaddle Authors. 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.
+
+
+import os
+
+from paddlenlp.version import git
+
+commit = "unknown"
+
+paddlenlp_dir = os.path.abspath(os.path.dirname(os.path.dirname(os.path.dirname(__file__))))
+if commit.endswith("unknown") and git.is_git_repo(paddlenlp_dir) and git.have_git():
+    commit = git.git_revision(paddlenlp_dir).decode("utf-8")
+    if git.is_dirty(paddlenlp_dir):
+        commit += ".dirty"
+del paddlenlp_dir
+
+
+__all__ = ["show"]
+
+
+def show():
+    """Get the corresponding commit id of paddlenlp.
+
+    Returns:
+        The commit-id of paddlenlp will be output.
+
+        full_version: version of paddlenlp
+
+
+    Examples:
+        .. code-block:: python
+
+            import paddlenlp
+
+            paddlenlp.version.show()
+            # commit: 1ef5b94a18773bb0b1bba1651526e5f5fc5b16fa
+
+    """
+    print("commit:", commit)

paddlenlp/version/git.py

@@ -0,0 +1,48 @@
+# Copyright (c) 2023 PaddlePaddle Authors. 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.
+
+"""Git utilities."""
+# https://github.com/python/mypy/blob/2c2d126cc742f2467045d36780c33bb8fb77a614/mypy/git.py#L1-L34
+# Used also from setup.py, so don't pull in anything additional here (like mypy or typing):
+from __future__ import annotations
+
+import os
+import subprocess
+
+
+def is_git_repo(dir: str) -> bool:
+    """Is the given directory version-controlled with git?"""
+    return os.path.exists(os.path.join(dir, ".git"))
+
+
+def have_git() -> bool:
+    """Can we run the git executable?"""
+    try:
+        subprocess.check_output(["git", "--help"])
+        return True
+    except subprocess.CalledProcessError:
+        return False
+    except OSError:
+        return False
+
+
+def git_revision(dir: str) -> bytes:
+    """Get the SHA-1 of the HEAD of a git repository."""
+    return subprocess.check_output(["git", "rev-parse", "HEAD"], cwd=dir).strip()
+
+
+def is_dirty(dir: str) -> bool:
+    """Check whether a git repository has uncommitted changes."""
+    output = subprocess.check_output(["git", "status", "-uno", "--porcelain"], cwd=dir)
+    return output.strip() != b""

setup.py

@@ -11,11 +11,14 @@
 # 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.
+import errno
 import io
 import os
 
 import setuptools
 
+from paddlenlp.version import commit
+
 PADDLENLP_STABLE_VERSION = "PADDLENLP_STABLE_VERSION"
 
 
@@ -25,6 +28,53 @@ def read_requirements_file(filepath):
     return requirements
 
 
+def write_version_py(filename="paddlenlp/version/__init__.py", content=None):
+    cnt = '''# THIS FILE IS GENERATED FROM PADDLENLP SETUP.PY
+commit           = '%(commit)s'
+
+__all__ = ['show']
+
+def show():
+    """Get the corresponding commit id of paddlenlp.
+
+    Returns:
+        The commit-id of paddlenlp will be output.
+
+        full_version: version of paddlenlp
+
+
+    Examples:
+        .. code-block:: python
+
+            import paddlenlp
+
+            paddlenlp.version.show()
+            # commit: 1ef5b94a18773bb0b1bba1651526e5f5fc5b16fa
+
+    """
+    print("commit:", commit)
+
+'''
+    commit_id = commit
+    if content is None:
+        content = cnt % {"commit": commit_id}
+
+    dirname = os.path.dirname(filename)
+
+    try:
+        os.makedirs(dirname)
+    except OSError as e:
+        if e.errno != errno.EEXIST:
+            raise
+    backup = None
+    if os.path.exists(filename):
+        backup = open(filename, "r").read()
+
+    with open(filename, "w") as f:
+        f.write(content)
+    return backup
+
+
 __version__ = "2.6.1.post"
 if os.getenv(PADDLENLP_STABLE_VERSION):
     __version__ = __version__.replace(".post", "")
@@ -65,41 +115,49 @@ def get_package_data_files(package, data, package_dir=None):
     return all_files
 
 
-setuptools.setup(
-    name="paddlenlp",
-    version=__version__,
-    author="PaddleNLP Team",
-    author_email="paddlenlp@baidu.com",
-    description="Easy-to-use and powerful NLP library with Awesome model zoo, supporting wide-range of NLP tasks from research to industrial applications, including Neural Search, Question Answering, Information Extraction and Sentiment Analysis end-to-end system.",
-    long_description=read("README_en.md"),
-    long_description_content_type="text/markdown",
-    url="https://github.com/PaddlePaddle/PaddleNLP",
-    license_files=("LICENSE",),
-    packages=setuptools.find_packages(
-        where=".",
-        exclude=("examples*", "tests*", "applications*", "fast_tokenizer*", "fast_generation*", "model_zoo*"),
-    ),
-    package_data={
-        "paddlenlp.ops": get_package_data_files(
-            "paddlenlp.ops", ["CMakeLists.txt", "README.md", "cmake", "fast_transformer", "patches", "optimizer"]
+origin_version_file = write_version_py(filename="paddlenlp/version/__init__.py")
+
+try:
+    setuptools.setup(
+        name="paddlenlp",
+        version=__version__,
+        author="PaddleNLP Team",
+        author_email="paddlenlp@baidu.com",
+        description="Easy-to-use and powerful NLP library with Awesome model zoo, supporting wide-range of NLP tasks from research to industrial applications, including Neural Search, Question Answering, Information Extraction and Sentiment Analysis end-to-end system.",
+        long_description=read("README_en.md"),
+        long_description_content_type="text/markdown",
+        url="https://github.com/PaddlePaddle/PaddleNLP",
+        license_files=("LICENSE",),
+        packages=setuptools.find_packages(
+            where=".",
+            exclude=("examples*", "tests*", "applications*", "fast_tokenizer*", "fast_generation*", "model_zoo*"),
         ),
-        "paddlenlp.transformers.layoutxlm": get_package_data_files(
-            "paddlenlp.transformers.layoutxlm", ["visual_backbone.yaml"]
-        ),
-    },
-    setup_requires=["cython", "numpy"],
-    install_requires=REQUIRED_PACKAGES,
-    entry_points={"console_scripts": ["paddlenlp = paddlenlp.cli:main"]},
-    extras_require=extras,
-    python_requires=">=3.6",
-    classifiers=[
-        "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.6",
-        "Programming Language :: Python :: 3.7",
-        "Programming Language :: Python :: 3.8",
-        "Programming Language :: Python :: 3.9",
-        "License :: OSI Approved :: Apache Software License",
-        "Operating System :: OS Independent",
-    ],
-    license="Apache 2.0",
-)
+        package_data={
+            "paddlenlp.ops": get_package_data_files(
+                "paddlenlp.ops", ["CMakeLists.txt", "README.md", "cmake", "fast_transformer", "patches", "optimizer"]
+            ),
+            "paddlenlp.transformers.layoutxlm": get_package_data_files(
+                "paddlenlp.transformers.layoutxlm", ["visual_backbone.yaml"]
+            ),
+        },
+        setup_requires=["cython", "numpy"],
+        install_requires=REQUIRED_PACKAGES,
+        entry_points={"console_scripts": ["paddlenlp = paddlenlp.cli:main"]},
+        extras_require=extras,
+        python_requires=">=3.6",
+        classifiers=[
+            "Programming Language :: Python :: 3",
+            "Programming Language :: Python :: 3.6",
+            "Programming Language :: Python :: 3.7",
+            "Programming Language :: Python :: 3.8",
+            "Programming Language :: Python :: 3.9",
+            "License :: OSI Approved :: Apache Software License",
+            "Operating System :: OS Independent",
+        ],
+        license="Apache 2.0",
+    )
+except Exception as e:
+    write_version_py(filename="paddlenlp/version/__init__.py", content=origin_version_file)
+    raise e
+
+write_version_py(filename="paddlenlp/version/__init__.py", content=origin_version_file)