Skip to content

Commit

Permalink
update readme file for keyword and category
Browse files Browse the repository at this point in the history
  • Loading branch information
xyluo25 committed Jan 15, 2025
1 parent c986cd8 commit 3cfaeff
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 14 deletions.
25 changes: 19 additions & 6 deletions docs/md_files/utility_function_by_category.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Note: we may not update available functions in time, please run code below to ch
pyufunc.show_util_func_by_category()
```

Available utility functions in pyUFunc (139):
Available utility functions in pyUFunc (152):

- util_ai:
- mean_absolute_error
Expand Down Expand Up @@ -52,18 +52,25 @@ Available utility functions in pyUFunc (139):
- timeout_linux

- util_data_processing:
- create_dataclass
- create_dataclass_from_dict
- cvt_digit_str_to_float
- cvt_digit_str_to_int
- cvt_int_to_alpha
- delete_dict_keys
- dataclass_dict_wrapper
- dict_delete_keys
- dict_split_by_chunk
- extend_dataclass
- get_layer_boundary
- is_float
- split_dict_by_chunk
- split_list_by_equal_sublist
- split_list_by_fixed_length
- list_flatten_nested
- list_split_by_equal_sublist
- list_split_by_fixed_length
- merge_dataclass
- str_strip

- util_datetime:
- cvt_dt_to_tz
- cvt_current_dt_to_tz
- fmt_dt_to_str
- fmt_str_to_dt
- get_time_diff_in_unit
Expand All @@ -77,6 +84,8 @@ Available utility functions in pyUFunc (139):
- list_all_timezones

- util_geo:
- calc_area_from_wkt_geometry
- calc_distance_on_unit_haversine
- calc_distance_on_unit_sphere
- create_circle_at_point_with_radius
- cvt_baidu09_to_gcj02
Expand All @@ -85,6 +94,7 @@ Available utility functions in pyUFunc (139):
- cvt_gcj02_to_wgs84
- cvt_wgs84_to_baidu09
- cvt_wgs84_to_gcj02
- download_elevation_tif_by
- find_closest_point
- find_k_nearest_points
- get_coordinates_from_geom
Expand Down Expand Up @@ -140,13 +150,16 @@ Available utility functions in pyUFunc (139):

- util_pathio:
- add_dir_to_env
- add_pkg_to_sys_path
- check_file_existence
- check_filename
- check_files_in_dir
- check_platform
- create_tempfile
- create_unique_filename
- find_duplicate_files
- find_executable_from_PATH_on_win
- find_fn_from_PATH_on_win
- generate_unique_filename
- get_dir_size
- get_file_size
Expand Down
27 changes: 19 additions & 8 deletions docs/md_files/utility_function_by_keyword.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,21 +20,25 @@ Note: we may not update available functions in time, please run code below to ch
pyufunc.show_util_func_by_keyword()
```

Available utility functions in pyUFunc (139):
Available utility functions in pyUFunc (152):

- non-keywords:
- add_date_in_filename
- add_dir_to_env
- add_pkg_to_sys_path
- count_lines_of_code
- delete_dict_keys
- dataclass_dict_wrapper
- dict_delete_keys
- dict_split_by_chunk
- download_elevation_tif_by
- end_of_life
- extend_dataclass
- func_running_time
- func_time
- import_package
- log_logger
- log_writer
- merge_dataclass
- path2linux
- path2uniform
- pickle_load
Expand Down Expand Up @@ -66,6 +70,7 @@ Available utility functions in pyUFunc (139):
- get_files_by_ext
- get_host_ip
- get_host_name
- get_layer_boundary
- get_osm_place
- get_terminal_height
- get_terminal_width
Expand All @@ -82,16 +87,22 @@ Available utility functions in pyUFunc (139):

- create:
- create_circle_at_point_with_radius
- create_dataclass
- create_dataclass_from_dict
- create_tempfile
- create_unique_filename

- find:
- find_closest_point
- find_duplicate_files
- find_executable_from_PATH_on_win
- find_fn_from_PATH_on_win
- find_k_nearest_points
- find_util_func_by_keyword

- calc:
- calc_area_from_wkt_geometry
- calc_distance_on_unit_haversine
- calc_distance_on_unit_sphere

- run:
Expand All @@ -116,6 +127,9 @@ Available utility functions in pyUFunc (139):

- list:
- list_all_timezones
- list_flatten_nested
- list_split_by_equal_sublist
- list_split_by_fixed_length

- img:
- img_bytes_to_CV
Expand All @@ -131,19 +145,16 @@ Available utility functions in pyUFunc (139):
- img_to_bytes
- img_translate

- split:
- split_dict_by_chunk
- split_list_by_equal_sublist
- split_list_by_fixed_length

- fmt:
- fmt_dt_to_str
- fmt_str_to_dt

- cvt:
- cvt_baidu09_to_gcj02
- cvt_baidu09_to_wgs84
- cvt_dt_to_tz
- cvt_current_dt_to_tz
- cvt_digit_str_to_float
- cvt_digit_str_to_int
- cvt_gcj02_to_baidu09
- cvt_gcj02_to_wgs84
- cvt_int_to_alpha
Expand Down

0 comments on commit 3cfaeff

Please sign in to comment.