acl anthology

Antologi ACL

Repositori ini berisi:

• Metadata untuk semua makalah, penulis, dan tempat di situs web antologi ACL.
• Kode dan instruksi untuk menghasilkan situs web.
• Paket Python untuk mengakses metadata , juga tersedia di PYPI.

Rumah resmi repositori ini adalah https://github.com/acl-org/acl-anthology.

Menggunakan paket python ACL-Antologi-Py

Silakan lihat readme terpisah untuk paket Python untuk informasi terperinci.

Menghasilkan situs web antologi

Ini adalah instruksi dasar tentang menghasilkan situs web antologi ACL seperti yang terlihat di https://aclanthology.org/.

Prasyarat

Untuk membangun situs web antologi, Anda akan membutuhkan:

• Python 3.8 atau lebih tinggi
• Paket Python yang tercantum dalam bin/requirements.txt ; Untuk menginstal, jalankan pip -r bin/requirements.txt
• Hugo 0.58.3 atau lebih tinggi (dapat diunduh langsung dari repo mereka; versi yang diperluas diperlukan!)
• Butils untuk membuat format kutipan non-Bibtex (tidak secara ketat diperlukan untuk membangun situs web, tetapi tanpa mereka perlu memohon langkah-langkah pembuatan secara manual seperti yang ditetapkan dalam readme terperinci)
• Opsional : Jika Anda menginstal libyaml-dev dan Cython sebelum berjalan make pertama kali, perpustakaan Libyaml C akan digunakan sebagai pengganti implementasi Python, mempercepat pembuatannya.

Membangun dan penempatan dengan github

Ada tindakan Github Tindakan yang melakukan penyebaran langsung dari GitHub. Untuk menggunakan ini, Anda perlu mendefinisikan variabel ini di pengaturan repositori Anda (Antarmuka Web: Pengaturan -> Rahasia):

• PUBLISH_SSH_KEY : Kunci rahasia dalam format PEM standar untuk otentikasi (tanpa frasa sandi)

GitHub kemudian akan secara otomatis membangun dan menggunakan master saat ini setiap kali cabang master berubah. Ini dilakukan melalui target upload di Makefile.

Kloning

Kloning repo antologi ke mesin lokal Anda:

$ git clone https://github.com/acl-org/acl-anthology

Menghasilkan

Asalkan Anda telah menginstal semua persyaratan dengan benar, membangun situs web harus sesederhana make dari direktori tempat Anda mengkloning repo.

Situs web yang dihasilkan sepenuhnya akan di build/anthology sesudahnya. Jika ada kesalahan yang terjadi selama langkah ini, Anda dapat berkonsultasi dengan ReadMe terperinci untuk informasi lebih lanjut tentang langkah -langkah individual yang dilakukan untuk membangun Situs. Anda dapat melihat situs web yang dihasilkan dengan meluncurkan server web lokal dengan make serve , yang akan melayani di http: // localhost: 8000.

Perhatikan bahwa membangun situs web adalah proses yang cukup padat sumber daya; Khususnya langkah terakhir, memohon Hugo, menggunakan sekitar 18 ~ GB memori sistem. Membangun antologi membutuhkan waktu sekitar 10 menit di laptop dengan SSD.

( Catatan: Ini tidak berarti Anda membutuhkan jumlah RAM ini dalam sistem Anda; pada kenyataannya, situs web ini dibangun dengan baik di atas laptop dengan 8 GB RAM. Namun, sistem ini mungkin melambat karena bertukar, bagaimanapun. Angka sekitar. 18 GB adalah penggunaan RAM maksimum yang dilaporkan saat menjalankan hugo --minify --stepAnalysis .)

Antologi dapat dilihat secara lokal dengan menjalankan hugo server di hugo/ Directory. Perhatikan bahwa itu membangun kembali situs dan karenanya membutuhkan waktu sekitar satu menit untuk memulai.

Hosting cermin antologi ACL

Pertama, membuat cermin lambat dan menekankan infrastruktur antologi ACL karena pada pengaturan awal Anda harus mengunduh setiap file antologi dari server web resmi. Ini bisa memakan waktu hingga 8 jam tidak peduli seberapa cepat koneksi Anda . Jadi tolong jangan bermain -main dengan ini hanya untuk bersenang -senang.

Jika Anda ingin meng -host cermin, Anda harus mengatur dua variabel lingkungan:

• ANTHOLOGY_PREFIX awalan http cermin Anda akan dicapai di bawah misalnya https://example.com/my-aweome-mirror atau http://aclanthology.lst.uni-saarland.de (perhatikan bahwa tidak ada tebasan di akhir!)
• ANTHOLOGYFILES Direktori di mana makalah, lampiran dll akan berada di server web Anda. Direktori ini harus dapat dibaca oleh server web Anda (jelas) tetapi tidak boleh menjadi subdirektori dari direktori Mirror Anthology.

Dengan variabel-variabel ini diatur, Anda menjalankan make untuk membuat halaman dan make mirror untuk mencerminkan semua file tambahan ke direktori build/antologi-file. Jika Anda sudah membuat cermin sebelumnya, itu hanya akan mengunduh file yang hilang.

Jika Anda ingin mencerminkan kertas tetapi tidak semua lampiran, Anda dapat menjalankan make mirror-no-attachments .

Anda kemudian rsync build/website/ Direktori ke Server Web Anda atau, jika Anda melayani cermin dalam FOO subdirektori, Anda mencerminkan build/website/FOO . Direktori build/anthology-files perlu diserahkan ke direktori ANTHOLOGYFILES webserver Anda.

Karena Anda mungkin ingin menjaga cermin tetap up to date, Anda dapat memodifikasi bin/acl-mirror-cronjob.sh sesuai kebutuhan Anda.

Anda akan membutuhkan perangkat lunak ini di server

• rsync
• git
• Python3
• Hugo> 0,58
• python3-venv

Jika Anda ingin proses pembuatan cepat, instal cython3 dan libyaml-dev (lihat di atas).

Perhatikan bahwa menghasilkan antologi membutuhkan sedikit ram, jadi pastikan itu tersedia di mesin Anda.

Berkontribusi

Jika Anda ingin berkontribusi pada antologi ACL, silakan lihat:

• Halaman Masalah GitHub kami
• Readme terperinci yang berisi lebih banyak informasi mendalam tentang menghasilkan dan memodifikasi situs web.

Sejarah

Repo ini awalnya adalah Wing-NUS/ACL dan telah ditransfer ke ACL-org pada 5 Juni 2017.

Lisensi

Kode untuk membangun antologi ACL didistribusikan di bawah lisensi Apache, v2.0.