Skip to content

Commit

Permalink
Auto-translate README
Browse files Browse the repository at this point in the history
  • Loading branch information
Continuous Integration committed Jun 15, 2024
1 parent 68ed13d commit 63eeb1a
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 13 deletions.
47 changes: 46 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,46 @@
当前地区当日额度已消耗完, 请尝试更换网络环境
# Data Preparation for Autosink Project

[🇬🇧](README.md) | [🇰🇷](README.kr.md) | [🇨🇳](README.zh-CN.md)

The data preparation component is originally responsible for fetching raw data. However, in our `autosink` project system, there is a feature store, so data preparation does not fetch raw data. Instead, it is considered as data preprocessing, such as image augmentation, which should be done in data preparation. The result of data preprocessing will actually be stored in the feature store. This package first explores the results of preprocessing in the feature store, and if it does not exist, it performs data preprocessing and passes the input to downstream components.

## Features

- [ ] Return the dataset after performing data preprocessing
- [ ] Prioritize exploring the feature store before performing data preprocessing and returning the result

# Environment

The environment is based on MacOS and Linux.

## `Makefile`

The `Makefile` has the following functions.

### `make lint`

- To use the `.vscode` settings, install the `pylint` extension.
- Overrides the options specified in the `pyproject.toml` file to lint the code based on the default settings of the linter.

### `make format`

- The formatter uses google's `yapf`.
- Overrides the options specified in the `pyproject.toml` file to format the code based on the default settings of the `yapf` formatter.
- To use the `.vscode` settings, install the `yapf` extension.

### `make test`

- Uses `unittest` for testing.
- Supports both `test_*.py` and `*_test.py` patterns.
- The test file must be connected to `__init__.py` up to the location of the test file.

### `make publish`

- Write the `~/.pypirc` file as follows.
```
[pypi]
username = __token__
password = pypi-어쩌고저쩌고 # Write your personal API token.
```
- Running this command will push the package to the PyPI public registry using `flit`.
- The package uploaded under the alias `myproject` will be available for anyone worldwide to install and use with `python3 -m pip install myproject`.
28 changes: 16 additions & 12 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,36 +2,40 @@

[🇬🇧](README.md) | [🇰🇷](README.kr.md) | [🇨🇳](README.zh-CN.md)

环境是基于 MacOS、Linux。
在字面上,数据准备组件最初负责获取原始数据。但是在我们的 `autosink` 项目系统中,由于存在特征存储,数据准备并不负责获取原始数据。我们将数据准备视为需要在数据准备中完成的工作,例如图像增强等数据预处理。在这种情况下,数据预处理的结果实际上将存储在特征存储中。该软件包首先在特征存储中查找已完成的预处理结果,如果不存在,则执行数据预处理,并将输入传递给下游组件。

## 功能

- [ ] 返回经过数据预处理的数据集
- [ ] 在执行数据预处理之前,首先在特征存储中进行搜索并返回

# 环境

环境适用于 MacOS 和 Linux。

## `Makefile`

`Makefile` 包含以下功能
`Makefile` 具有以下功能

### `make lint`

- 若要使用 `.vscode` 设置,请安装 `pylint` 扩展。
- 通过覆盖 linter 的默认设置中在 `pyproject.toml` 文件中指定的选项来对代码进行 lint
- 通过覆盖默认设置中 `pyproject.toml` 文件中指定的选项,对代码进行检查

### `make format`

- 使用 google 的 `yapf` 作为格式化工具
- 通过覆盖 `yapf` 格式化器的默认设置中在 `pyproject.toml` 文件中指定的选项来格式化代码
- 格式化程序使用 google 的 `yapf`
- 通过覆盖默认设置中 `pyproject.toml` 文件中指定的选项,对代码进行格式化
- 若要使用 `.vscode` 设置,请安装 `yapf` 扩展。

### `make test`

- 使用 `unittest` 进行测试。
- 支持 `test_*.py``*_test.py` 模式。
- 测试文件必须通过 `__init__.py` 连接到测试文件所在的位置
- 测试文件必须连接到包含测试文件的位置,并且连接到 `__init__.py`

### `make publish`

- 请按以下格式编写 `~/.pypirc` 文件。
```
[pypi]
username = __token__
password = pypi-xxxxxx # 请获取个人 API 令牌并填写
```
- 运行此命令将使用 `flit` 将软件包推送到 PyPI 公共注册表。
- 通过之前指定的名称 `myproject`(别名),软件包将被上传,任何人都可以通过 `python3 -m pip install myproject` 安装并使用软件包。
[p

0 comments on commit 63eeb1a

Please sign in to comment.