Merge branch 'release/2.2' of https://github.com/PaddlePaddle/docs into release/2.2

Author: zhangkaihuo

ci_scripts/checkapproval.sh

@@ -9,12 +9,12 @@ for API_FILE in ${API_FILES[*]}; do
   if [ "${API_CHANGE}" ];then
     approval_line=`curl -H "Authorization: token ${GITHUB_API_TOKEN}" https://api.github.com/repos/PaddlePaddle/docs/pulls/${GIT_PR_ID}/reviews?per_page=10000`
     if [ "${API_FILE}" == "docs/api/paddle" ];then
-      APPROVALS=`echo ${approval_line} | python ./check_pr_approval.py 1 2870059 27208573 29231 28379894 23093488 11935832`
+      APPROVALS=`echo ${approval_line} | python ./check_pr_approval.py 1 29231 23093488 11935832 39876205`
     fi
   fi
   if [ "${APPROVALS}" == "FALSE" ]; then
     if [ "${API_FILE}" == "docs/api/paddle" ];then
-      echo "You must have one TPM (saxon-zh or swtkiwi or jzhang533 or Heeenrrry or dingjiaweiww or TCChenlong) approval for the api change! ${API_FILE} for the management reason of API interface and API document."
+      echo "You must have one TPM (jzhang533/ZhangJun or dingjiaweiww/DingJiaWei or TCChenlong/ChenLong or Ligoml/LiMengLiu) approval for the api change! ${API_FILE} for the management reason of API interface and API document."
     fi
     exit 1
   fi

ci_scripts/hooks/pre-doc-compile.sh

@@ -26,3 +26,11 @@ for f in ${FILES_ARRAY[@]} ; do
     cat ${TMP_FILE} >> $TARGET_FILE
 done
 
+
+## 2 convert all ipynb files to markdown, and delete the ipynb files.
+# ../practices/**/*.ipynb
+for i in ${SCRIPT_DIR}/../../docs/practices/**/*.ipynb ; do
+    echo "convert $i to markdown and delete ipynb"
+    jupyter nbconvert --to markdown "$i"
+    rm "$i"
+done

docs/api/gen_doc.py

@@ -141,17 +141,23 @@ def process_module(m, attr="__all__"):
                 if inspect.isclass(api_info['object']):
                     for name, value in inspect.getmembers(api_info['object']):
                         if (not name.startswith("_")):
-                            method_full_name = full_name + '.' + name  # value.__name__
-                            if name and value and isinstance(value, property):
-                                method_api_info = insert_api_into_dict(
-                                    method_full_name, 'class_property')
-                                if method_api_info is not None:
-                                    api_counter += 1
-                            elif hasattr(value, '__name__'):
-                                method_api_info = insert_api_into_dict(
-                                    method_full_name, 'class_method')
-                                if method_api_info is not None:
-                                    api_counter += 1
+                            try:
+                                method_full_name = full_name + '.' + name  # value.__name__
+                                if name and value and isinstance(value,
+                                                                 property):
+                                    method_api_info = insert_api_into_dict(
+                                        method_full_name, 'class_property')
+                                    if method_api_info is not None:
+                                        api_counter += 1
+                                elif hasattr(value, '__name__'):
+                                    method_api_info = insert_api_into_dict(
+                                        method_full_name, 'class_method')
+                                    if method_api_info is not None:
+                                        api_counter += 1
+                            except ValueError as e:
+                                logger.error(
+                                    'ValueError when processing %s: %s',
+                                    method_full_name, str(e))
     return api_counter
 
 
@@ -226,9 +232,14 @@ def parse_module_file(mod):
     if hasattr(mod, '__name__') and hasattr(mod, '__file__'):
         src_file = mod.__file__
         mod_name = mod.__name__
+        if not (isinstance(src_file, str) and isinstance(src_file, str)):
+            logger.error('%s: mod_name=%s, src_file=%s',
+                         str(mod), mod_name, src_file)
+            return
         logger.debug("parsing %s:%s", mod_name, src_file)
         if len(mod_name) >= 6 and mod_name[:6] == 'paddle':
-            if os.path.splitext(src_file)[1].lower() == '.py':
+            fn_splited = os.path.splitext(src_file)
+            if len(fn_splited) > 1 and fn_splited[1].lower() == '.py':
                 mod_ast = ast.parse(open(src_file, "r").read())
                 for node in mod_ast.body:
                     short_names = []
@@ -436,7 +447,8 @@ def set_api_sketch():
         paddle.device,
         paddle.device.cuda,
         paddle.linalg,
-        paddle.fft
+        paddle.fft,
+        paddle.version
     ]
 
     alldict = {}
@@ -533,44 +545,6 @@ def collect_referenced_from_infos(docdirs):
         docdirs)
 
 
-def get_shortest_api(api_list):
-    """
-    find the shortest api name (suggested name) in list.
-
-    Problems:
-    1. fuild - if there is any apis don't contain 'fluid' in name, use them.
-    2. core vs core_avx - using the 'core'.
-    """
-    if len(api_list) == 1:
-        return api_list[0]
-    # try to find shortest path of api as the real api
-    api_info = [
-    ]  # {'name': name, 'fluid_in_name': True/False, 'core_avx_in_name': True/Flase', 'len': len}
-    for api in api_list:
-        fields = api.split('.')
-        api_info.append({
-            'name': api,
-            'fluid_in_name': 'fluid' in fields,
-            'core_avx_in_name': 'core_avx' in fields,
-            'len': len(fields),
-        })
-
-    def shortest(api_info):
-        if not api_info:
-            return None
-        elif len(api_info) == 1:
-            return api_info[0].get('name')
-        api_info.sort(key=lambda ele: ele.get('len'))
-        return api_info[0].get('name')
-
-    if not all([api.get('fuild_in_name') for api in api_info]):
-        api_info = [api for api in api_info if not api.get('fluid_in_name')]
-    sn = shortest([api for api in api_info if not api.get('core_avx_in_name')])
-    if sn is None:
-        sn = shortest(api_info)
-    return sn
-
-
 def remove_all_en_files(path="./paddle"):
     """
     remove all the existed en doc files
@@ -768,8 +742,13 @@ def print_class(self):
         }
         tmpl = 'default'
         for m in [
-                'fluid.dygraph', 'paddle.vision', 'paddle.callbacks',
-                'paddle.hapi.callbacks', 'paddle.io', 'paddle.nn'
+                'fluid.dygraph',
+                'paddle.vision',
+                'paddle.callbacks',
+                'paddle.hapi.callbacks',
+                'paddle.io',
+                'paddle.nn',
+                'paddle.incubate.nn',
         ]:
             if self.api_name.startswith(m):
                 tmpl = 'no-inherited'
@@ -822,11 +801,65 @@ def __call__(self):
         return self.api_name, self.api_ref_name
 
 
+def get_shortest_api(api_list):
+    """
+    find the shortest api name (suggested name) in list.
+
+    Problems:
+    1. fuild - if there is any apis don't contain 'fluid' in name, use them.
+    2. core vs core_avx - using the 'core'.
+    """
+    if len(api_list) == 1:
+        return api_list[0]
+    # try to find shortest path of api as the real api
+    api_info = [
+    ]  # {'name': name, 'fluid_in_name': True/False, 'core_avx_in_name': True/Flase', 'len': len}
+    for api in api_list:
+        fields = api.split('.')
+        api_info.append({
+            'name': api,
+            'fluid_in_name': 'fluid' in fields,
+            'core_avx_in_name': 'core_avx' in fields,
+            'len': len(fields),
+        })
+
+    def shortest(api_info):
+        if not api_info:
+            return None
+        elif len(api_info) == 1:
+            return api_info[0].get('name')
+        api_info.sort(key=lambda ele: ele.get('len'))
+        return api_info[0].get('name')
+
+    if not all([api.get('fuild_in_name') for api in api_info]):
+        api_info = [api for api in api_info if not api.get('fluid_in_name')]
+    sn = shortest([api for api in api_info if not api.get('core_avx_in_name')])
+    if sn is None:
+        sn = shortest(api_info)
+    return sn
+
+
 def insert_suggested_names():
     """
-    add suggested_name field, updte the doc_filename, and sort the all_names.
+    add suggested_name field, updte the doc_filename, and sort the all_names and api_sketch_names.
     """
     pat = re.compile(r'paddle\.fluid\.core_[\w\d]+\.(.*)$')
+
+    def sort_name_list(api_names):
+        """
+        sort and move paddle.Tensor.* to the end
+        """
+        names_sorted = sorted(list(api_names))
+        cnt = 0  # count of paddle.Tensor.*
+        for n in names_sorted:
+            if n.startswith('paddle.Tensor.'):
+                cnt += 1
+            else:
+                break
+        if cnt:
+            names_sorted = names_sorted[cnt:] + names_sorted[:cnt]
+        return names_sorted
+
     for id_api in api_info_dict:
         if "all_names" not in api_info_dict[id_api]:
             api_info_dict[id_api]["all_names"] = set()
@@ -840,9 +873,15 @@ def insert_suggested_names():
             if mo:
                 api_info_dict[id_api]["all_names"].add('paddle.fluid.core.' +
                                                        mo.group(1))
-        api_info_dict[id_api]["all_names"] = sorted(
-            list(api_info_dict[id_api]["all_names"]))
-        sn = get_shortest_api(api_info_dict[id_api]["all_names"])
+        api_info_dict[id_api]["all_names"] = sort_name_list(
+            api_info_dict[id_api]["all_names"])
+        sn = None
+        if 'api_sketch_names' in api_info_dict[id_api]:
+            api_info_dict[id_api]['api_sketch_names'] = sort_name_list(
+                api_info_dict[id_api]['api_sketch_names'])
+            sn = get_shortest_api(api_info_dict[id_api]['api_sketch_names'])
+        if not sn:
+            sn = get_shortest_api(api_info_dict[id_api]["all_names"])
         if sn:
             # Delete alias_name, api_info_dict[id_api]["alias_name"] = sn
             api_info_dict[id_api]["suggested_name"] = sn
@@ -1239,8 +1278,8 @@ def parse_args():
         set_display_attr_of_apis()
         set_source_code_attrs()
         set_referenced_from_attr()
-        insert_suggested_names()
         set_api_sketch()
+        insert_suggested_names()
         if ('__all__' not in realattrs) or ('__all__' in realattrs and
                                             realattr == '__all__'):
             if args.gen_rst: