Use a serialization library that is bidirectional between julia versions

Open
  • Is something wrong?
#49 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
julia
Domain
devtools

Research direction

Start by reviewing the current uses of Julia's standard-library Serialization and the compatibility requirements described in the issue. Compare JLD2.jl and BSON.jl against those requirements; the work is complete only once a library choice and an implementation scope have been agreed.

Written by the indexing model from the issue text.

Description

It would be nice to move away from the standard library Serialization, as it only guarantees that newer julia versions can read files written by older ones, and not the other way. Bi-directionality is needed.

Based on the recommendations in https://fluxml.ai/Flux.jl/stable/saving/, options are https://github.com/JuliaIO/JLD2.jl and https://github.com/JuliaIO/BSON.jl. Perhaps lightweightness should be a priority. On my system, in a temp environment, I get

julia> @time using JLD2
  0.312673 seconds (316.65 k allocations: 18.135 MiB)

julia> @time using BSON
  0.002721 seconds (3.12 k allocations: 288.133 KiB)

Also, BSON.jl has no dependencies, so I guess there is less that can go wrong there? It seems appropriate to use a minimal low-dependency library for serialization in the context of RemoteREPL, so I suggest BSON.jl. Is this a direction that can be agreed on?

Dominant language
Julia
Stars
148
Forks
17
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from JuliaWeb/RemoteREPL.jl

All issues in JuliaWeb/RemoteREPL.jl

Similar issues

More Julia issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.