semvec/pypi-packages huggingface dataset:
efficiency 2.0
A package for efficient programming
License: MIT

# efficiency

[![Pypi](https://img.shields.io/pypi/v/efficiency.svg)](https://pypi.org/project/efficiency)
[![Downloads](https://pepy.tech/badge/efficiency)](https://pepy.tech/project/efficiency)
[![Downloads](https://pepy.tech/badge/efficiency/month)](https://pepy.tech/project/efficiency/month)
[![MIT_License](https://camo.githubusercontent.com/890acbdcb87868b382af9a4b1fac507b9659d9bf/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c75652e737667)](LICENCE)

This is a package of useful one-line logging functions made by Zhijing.

## Installation

Requirement: Python 3

```
pip install --upgrade  git+https://github.com/zhijing-jin/efficiency.git
```

## Logging Shortcuts

Obtain time:

```python
>>> from efficiency.log import show_time, fwrite
>>> time_stamp = show_time()
	time: 11241933-41
>>> time_stamp
'11241933' # means: Nov 24th, 19:33
```

Writing out to files by one line:

```python
>>> text = "This is handy!"
>>> fwrite(text, "temp.txt")
```

Printing out variables (name + value) easily:

```python
>>> num1 = 7
>>> num2 = 2
>>> num3 = 9
>>> show_var(["num1", "num2", "num3"])
num1 : 7
num2 : 2
num3 : 9
```

### ML-Related

```python
>>> from efficiency.log import gpu_mem
>>> gpu_mem(gpu_id=0)
4101 # Currently, GPU Memory of GPU #0 is 4101 MiB
>>> from efficiency.function import set_seed
>>> set_seed(0)
[Info] seed set to: 0 # set the seed for random, numpy and pytorch
```

## Useful Functions

```python
>>> from efficiency.function import shell
>>> stdout, stderr = shell("cat temp.txt")
>>> stdout
b'This is handy!'
```

# Miscellaneous Functions

#### Formatting README.md Better

This is the way to automatically generate table of contents for an .md file using [markdown_toc](https://github.com/alexharv074/markdown_toc):

```
# Step 1. download the file to your local execution path `/usr/local/bin/`
curl \
  https://raw.githubusercontent.com/alexharv074/markdown_toc/master/mdtoc.rb -o \
  /usr/local/bin/mdtoc.rb

# Step 2. generate the ToC in the "copy" mode
mdtoc.rb README.md

# Alternatively, you can automatically add the content to your copyboard and paste it to your .md
mdtoc.rb README.md | pbcopy
```
toishi 0.1.2
日本語テキストのフォーマッター。名称は日本の伝統的な刃物の研ぎに使用される砥石(toishi)をモチーフにしています
License: MIT
Requires Python: >=3.12,<4.0

# toishi

日本語テキストのフォーマッター。
名称は、日本の伝統的な刃物の研ぎに使用される砥石(toishi)をモチーフにしています。

## 開発背景

- 日本語テキストをテキストエディタで修正しつつ、リポジトリでバージョン管理することがありました。
- バージョン管理にあたり、行ごとに改行が入っている方が履歴が追跡しやすくなります。
- 日本語を書くのに夢中になり、不必要な改行が入ることもあります。しかし、それを手作業でチェックするのは煩雑です。
- コードフォーマッターのように自動で修正してほしい、という想いから作りました。

## コンセプト

- 表現の柔軟性を削り、文章を型にはめることで、文章が持つ情報そのものに注目させる。
- フォーマットの自由度を落とすことで、利用者の表現に関する議論を削減する。
- 手動でのフォーマット作業を省くことで、執筆者をより重要な作業に集中させる。

## インストール

```
pip install toishi
```

## 利用方法

filename.txtに任意のファイル名を指定してください。

```
toishi filename.txt
```

## 機能(開発中)

現在、開発中です。以下は追加予定の機能です。

- [x]  「。」の後に改行を自動で入れる。
- [ ] 空行は連続しない。1行のみ。 複数行ある場合は、1行にする。
- [ ] ファイルの先頭の空行、最後の空行は削除する。
- [ ] チェックのみで修正を入れないオプション（CI用）
- [ ] ディレクトリを指定し、一括で処理する機能